List Order Shipments

GET {{baseUrl}}/orders/:order_id/shipments

This endpoint allows you to fetch the complete details of a specific Order Shipments by providing the ID of the order you want to get its details in the order path parameter. Scope: orders.read- Orders Read Only

HEADERS

RESPONSES

status: OK

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":[{"id":"\u003cnumber\u003e","created_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},"type":"return","courier_id":"\u003cinteger\u003e","courier_name":"\u003cstring\u003e","courier_logo":"\u003cstring\u003e","shipping_number":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","pickup_id":"\u003cstring\u003e","trackable":true,"tracking_link":"\u003cstring\u003e","label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"payment_method":"\u003cstring\u003e","source":"\u003cstring\u003e","status":"\u003cstring\u003e","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"is_international":false,"total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":[{"item_id":"\u003cnumber\u003e","external_id":"\u003cstring\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cnumber\u003e","weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"}},{"item_id":"\u003cnumber\u003e","external_id":"\u003cstring\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cnumber\u003e","weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"}}],"ship_from":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","country_code":"\u003cstring\u003e","city":"\u003cstring\u003e","city_id":"\u003cnumber\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","longitude":"\u003cnumber\u003e","latitude":"\u003cnumber\u003e","branch_id":"\u003cnumber\u003e"},"ship_to":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","city_id":"\u003cnumber\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cinteger\u003e","longitude":"\u003cinteger\u003e"},"meta":{"app_id":"\u003cstring\u003e","policy_options":{"boxes":"\u003cnumber\u003e","dimensions":{"length":"\u003cstring\u003e","width":"\u003cstring\u003e","height":"\u003cstring\u003e"},"shipment_content_type":["\u003cstring\u003e","\u003cstring\u003e"],"packaging_type":["\u003cstring\u003e","\u003cstring\u003e"]}}},{"id":"\u003cnumber\u003e","created_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},"type":"shipment","courier_id":"\u003cinteger\u003e","courier_name":"\u003cstring\u003e","courier_logo":"\u003cstring\u003e","shipping_number":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","pickup_id":"\u003cstring\u003e","trackable":true,"tracking_link":"\u003cstring\u003e","label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"payment_method":"\u003cstring\u003e","source":"\u003cstring\u003e","status":"\u003cstring\u003e","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"is_international":false,"total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":[{"item_id":"\u003cnumber\u003e","external_id":"\u003cstring\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cnumber\u003e","weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"}},{"item_id":"\u003cnumber\u003e","external_id":"\u003cstring\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cnumber\u003e","weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"}}],"ship_from":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","country_code":"\u003cstring\u003e","city":"\u003cstring\u003e","city_id":"\u003cnumber\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","longitude":"\u003cnumber\u003e","latitude":"\u003cnumber\u003e","branch_id":"\u003cnumber\u003e"},"ship_to":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","city_id":"\u003cnumber\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cinteger\u003e","longitude":"\u003cinteger\u003e"},"meta":{"app_id":"\u003cstring\u003e","policy_options":{"boxes":"\u003cnumber\u003e","dimensions":{"length":"\u003cstring\u003e","width":"\u003cstring\u003e","height":"\u003cstring\u003e"},"shipment_content_type":["\u003cstring\u003e","\u003cstring\u003e"],"packaging_type":["\u003cstring\u003e","\u003cstring\u003e"]}}}],"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}}