Auth
- POSTAnonymous user
- POSTLogin with phone
- POSTLogin with email
- POSTLogin with whatsapp
- POSTLogin with password
- POSTVerify OTP
- POSTRegister with phone
- POSTRegister with email
- POSTRegister with whatsapp
- POSTRegister with password
- GETRetrieve a user
- PUTUpdate a user
- GETRetrieve a profile image
- PUTUpdate profile image
- POSTAdd profile image
- DELDelete profile image
- PUTDeactivate account
- POSTRefresh access token
- POSTChange password
- POSTForgot password
- POSTReset password
- GETRetrieve user notification preferences
- PUTUpdate user notification preferences
- POSTCreate user notification preferences
- POSTGenerate OTP
- POSTLogout user
- POSTCheck email/phone verification status
Catalog
Carts
- POSTCreate cart
- GETRetrieve cart detail
- DELDelete cart
- GETRetrieve cart using user id
- DELDelete cart using user id
- POSTAdd/delete cart item
- POSTUpdate cart address
- POSTApply coupon
- DELRemove coupon
- POSTRedeem loyalty points
- DELRemove loyalty points
- POSTUse credit balance
- DELRemove credit balance
- POSTRedeem gift card
- DELRemove gift card
- GETRetrieve wishlist
- POSTAdd product to wishlist
- DELDelete product from wishlist
Coupons & promotions
Customers
Orders
Shipping
Analytics
Campaigns
Orders
Retrieve order shipments
Orders
Retrieve order shipments
Retrieve order shipments
GET
/
orders
/
{order_number}
/
shipments
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders/{order_number}/shipments \
--header 'Authorization: Bearer <token>'
{
"message": "order details",
"success": true,
"content": {
"shipments": [
{
"reference_number": "<string>",
"status": "unscheduled",
"total_weight": 123,
"total_boxes": 123,
"shipment_items_count": 123,
"shipment_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"shipping_amount": 123,
"shipping_tax_amount": 123,
"shipping_amount_including_tax": 123,
"courier_company_name": "<string>",
"shipping_label_url": "<string>",
"awb_no": "<string>",
"tracking_url": "<string>",
"eta_delivery": "<string>",
"shipped_date": "2023-11-07T05:31:56Z",
"delivered_date": "2023-11-07T05:31:56Z",
"cancellation_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
]
}
}
Authorizations
Access token
Path Parameters
order number
Response
200
application/json
OK
Order shipment model
Available options:
unscheduled
, schedule_requested
, scheduled
, packed
, shipped
, in_transit
, out_for_delivery
, delivery_attempted
, undelivered
, return_to_origin
, delivered
, cancelled
Shipment item model
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/orders/{order_number}/shipments \
--header 'Authorization: Bearer <token>'
{
"message": "order details",
"success": true,
"content": {
"shipments": [
{
"reference_number": "<string>",
"status": "unscheduled",
"total_weight": 123,
"total_boxes": 123,
"shipment_items_count": 123,
"shipment_items": [
{
"product_id": "<string>",
"product_name": "<string>",
"product_image_url": "<string>",
"sku": "<string>",
"quantity": 123,
"free_quantity": 123,
"is_free_item": true
}
],
"shipping_amount": 123,
"shipping_tax_amount": 123,
"shipping_amount_including_tax": 123,
"courier_company_name": "<string>",
"shipping_label_url": "<string>",
"awb_no": "<string>",
"tracking_url": "<string>",
"eta_delivery": "<string>",
"shipped_date": "2023-11-07T05:31:56Z",
"delivered_date": "2023-11-07T05:31:56Z",
"cancellation_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
]
}
}