ποΈ Commerce
- Catalog
- Carts
- Coupons & Promotions
- Orders
- Shipping
- Payments
- Subscriptions
π Customers
- Auth
- Customers
- KYC
ποΈ Engagement & Retention
- Campaigns
- Analytics
π§° Utilities
- Common
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
The response is of type object
.
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"
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.