Catalog
- GETRetrieve all products
- POSTCreate product
- GETRetrieve skus
- GETRetrieve product details
- PUTUpdate product details
- DELDelete product
- GETRetrieve product variants
- POSTCreate variant
- POSTUpdate variants in bulk
- GETRetrieve a variant details
- PUTUpdate a variant
- DELDelete a variant
- GETRetrieve product inventory
- POSTUpdate product inventory
- GETRetrieve product inventory activities
- PUTUpdate product inventory activities
- POSTCreate product inventory activities
- GETRetrieve product reviews
- GETRetrieve product review
- PUTUpdate product review
- DELDelete product review
- GETRetrieve all categories
- POSTCreate category
- GETRetrieve category
- PUTUpdate category
- DELDelete category
- GETRetrieve all attributes
- POSTCreate attribute
- GETRetrieve attribute
- PUTUpdate attribute
- DELDelete attribute
- POSTAdd product pricing
- PUTUpdate product pricing
- DELDelete product pricing
- POSTAdd product image
- PUTUpdate product image
- DELDelete product image
- GETRetrive sku detail
Auth
- PUTActivate user account
- PUTDeactivate user account
- GETCheck domain availability
- GETRetrieve all roles
- POSTCreate new role
- PUTUpdate role
- DELDelete role
- GETRetrieve all permissions of a role
- POSTAdd permission to role
- DELRemove permission from role
- GETRetrieve all members
- POSTCreate new member
- GETRetrieve member detail
- PUTUpdate member details
- DELDelete member
- GETRetrieve all roles of a member
- POSTAssigne role to member
- DELRemove role from member
Coupons & promotions API
- GETList all coupons
- POSTCreate coupon
- GETRetrieve coupon details
- PUTUpdate coupon
- DELDelete coupon
- GETList all coupon codes
- POSTAdd coupon code
- GETList all coupon customers
- GETRetrieve coupon usage
- GETList all promotions
- POSTCreate promotion
- GETRetrieve promotion details
- PUTUpdate promotion
- DELDelete promotion
- GETList all promotion usage
- GETList all promotion customers
Warehouse
Orders API
Shipping API
Customers API
Segments API
Payments API
Media Gallery API
Shipping API
Retrieve shipment detail
GET
/
shipping
/
shipments
/
{order-number}
curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/shipping/shipments/{order-number} \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"shipment": {
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"order_status": "<string>",
"payment_status": "pending",
"customer_name": "<string>",
"shipments": [
{
"shipment_number": "<string>",
"warehouse_id": "<string>",
"warehouse_name": "<string>",
"status": "<string>",
"total_weight": 123,
"total_boxes": 123,
"shipment_items_count": 123,
"shipping_amount": 123,
"shipping_tax_amount": 123,
"shipping_amount_including_tax": 123,
"courier_company_name": "<string>",
"awb_no": "<string>",
"shipping_label_url": "<string>",
"eta_delivery": "<string>",
"shipped_date": "<string>",
"delivered_date": "<string>",
"slo": {
"expected_date": "2023-12-25",
"actual_date": "2023-12-25",
"difference": "<string>"
},
"cancellation_reason": "<string>",
"created_at": "<string>",
"modified_at": "<string>",
"shipment_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"packaging": {
"package_option": "Automatic",
"boxes_count": 123,
"boxes": [
{
"box_name": "<string>",
"box_length": 123,
"box_width": 123,
"box_height": 123,
"box_weight": 123,
"packed_items_count": 123
}
]
}
}
],
"allowed_actions": [
"Refund shortfall"
]
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Order number
Response
200 - application/json
OK
Available options:
pending
, success
, failed
Available options:
Refund shortfall
, Wait for inventory
, Reject order
curl --request GET \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/shipping/shipments/{order-number} \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"shipment": {
"order_number": "<string>",
"order_date": "2023-11-07T05:31:56Z",
"order_status": "<string>",
"payment_status": "pending",
"customer_name": "<string>",
"shipments": [
{
"shipment_number": "<string>",
"warehouse_id": "<string>",
"warehouse_name": "<string>",
"status": "<string>",
"total_weight": 123,
"total_boxes": 123,
"shipment_items_count": 123,
"shipping_amount": 123,
"shipping_tax_amount": 123,
"shipping_amount_including_tax": 123,
"courier_company_name": "<string>",
"awb_no": "<string>",
"shipping_label_url": "<string>",
"eta_delivery": "<string>",
"shipped_date": "<string>",
"delivered_date": "<string>",
"slo": {
"expected_date": "2023-12-25",
"actual_date": "2023-12-25",
"difference": "<string>"
},
"cancellation_reason": "<string>",
"created_at": "<string>",
"modified_at": "<string>",
"shipment_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"packaging": {
"package_option": "Automatic",
"boxes_count": 123,
"boxes": [
{
"box_name": "<string>",
"box_length": 123,
"box_width": 123,
"box_height": 123,
"box_weight": 123,
"packed_items_count": 123
}
]
}
}
],
"allowed_actions": [
"Refund shortfall"
]
}
}
}