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.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":[{"id":"\u003cnumber\u003e","tracking_number":"\u003cstring\u003e","pickup_id":"\u003cstring\u003e","courier_id":"\u003cinteger\u003e","courier_name":"\u003cstring\u003e","type":"shipment","trackable":true,"tracking_link":"\u003cstring\u003e","ship_to":{"name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cinteger\u003e","longitude":"\u003cinteger\u003e"},"ship_from":{"name":"\u003cstring\u003e","company_name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e"},"label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"is_international":false,"total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":[{"weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"}},{"weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"}}],"meta":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"}},{"id":"\u003cnumber\u003e","tracking_number":"\u003cstring\u003e","pickup_id":"\u003cstring\u003e","courier_id":"\u003cinteger\u003e","courier_name":"\u003cstring\u003e","type":"return","trackable":true,"tracking_link":"\u003cstring\u003e","ship_to":{"name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cinteger\u003e","longitude":"\u003cinteger\u003e"},"ship_from":{"name":"\u003cstring\u003e","company_name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e"},"label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"is_international":false,"total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":[{"weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"}},{"weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"}}],"meta":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"}}],"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}}