List Shipments

GET https://api.salla.dev/admin/v2/shipments

You can list all shipments related to your store directly from this endpoint. Also, it allows you to filter them using by shipping company slug.

HEADERS

RESPONSES

status: OK

{"status":"\u003cstring\u003e","success":"\u003cboolean\u003e","data":[{"id":"\u003cinteger\u003e","order_id":"\u003cinteger\u003e","order_reference_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":{"nullable":true,"description":"Shipment Pickup ID","example":"10954392"},"trackable":"\u003cboolean\u003e","tracking_link":"\u003cstring\u003e","label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"payment_method":"cod","source":"\u003cstring\u003e","status":"creating","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"is_international":"\u003cboolean\u003e","total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":[{"name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","units":"oz"}},{"name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","units":"lb"}}],"ship_from":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":{"nullable":true,"description":"Shipment Ship From Street Number","example":"120B"},"block":{"nullable":true,"description":"Shipment Ship From Block","example":"Block AB"},"postal_code":{"nullable":true,"description":"Shipment Ship From Postal Code","example":"1000"},"latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e","branch_id":"\u003cinteger\u003e"},"ship_to":{"type":"\u003cstring\u003e","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"},"meta":{"app_id":"\u003cinteger\u003e","policy_options":{"boxes":"\u003cinteger\u003e"}},"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}},{"id":"\u003cinteger\u003e","order_id":"\u003cinteger\u003e","order_reference_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":{"nullable":true,"description":"Shipment Pickup ID","example":"10954392"},"trackable":"\u003cboolean\u003e","tracking_link":"\u003cstring\u003e","label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"payment_method":"cod","source":"\u003cstring\u003e","status":"returned","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"is_international":"\u003cboolean\u003e","total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":[{"name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","units":"g"}},{"name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","units":"lb"}}],"ship_from":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":{"nullable":true,"description":"Shipment Ship From Street Number","example":"120B"},"block":{"nullable":true,"description":"Shipment Ship From Block","example":"Block AB"},"postal_code":{"nullable":true,"description":"Shipment Ship From Postal Code","example":"1000"},"latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e","branch_id":"\u003cinteger\u003e"},"ship_to":{"type":"\u003cstring\u003e","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"},"meta":{"app_id":"\u003cinteger\u003e","policy_options":{"boxes":"\u003cinteger\u003e"}},"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":["\u003cstring\u003e","\u003cstring\u003e"]}}]}