List Shipments
GET
/shipmentsYou can list all shipments related to your store directly from this endpoint. Also, it allows you to filter them using by shipping company slug.
Request
Shipment Status; value can be one of the listed enum variables
Shipment Type; value can either "shipment"
or "return"
Payment Method; value can either "pre_paid"
or "cod"
Shipment starting date range
Shipment ending date range
Shipment Country Destination. Get a list of Country IDs from here
Shipment Country Code Destination. Get a list of Country Codes from here
Shipment City Destination. Get a list of City IDs from here
Shipment Country Origin. Get a list of Country IDs from here
Shipment Country Code Origin. Get a list of Country Codes from here
Shipment City Origin. Get a list of City IDs from here
Shipment Source; value can be one of the listed enum variables
Shipments limit per page
Request samples
Respostas
{
"status": 200,
"success": true,
"data": [
{
"id": 362985662,
"order_id": 560695738,
"order_reference_id": 48927,
"created_at": {
"date": "2023-01-18 09:35:03.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"type": "return",
"courier_id": 814202285,
"courier_name": "DHL",
"courier_logo": "https://company.com/logo.png",
"shipping_number": "0",
"tracking_number": "0",
"pickup_id": null,
"trackable": true,
"tracking_link": "https://www.company/tracking/tracking-express.html?submit=1&tracking-id=12345",
"label": [],
"payment_method": "cod",
"source": "api",
"status": "creating",
"total": {
"amount": 0,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": "10.70",
"currency": "SAR"
},
"meta": {
"app_id": null,
"policy_options": []
},
"ship_from": {
"type": "address",
"name": "Username",
"email": "[email protected]",
"phone": "055-555-555",
"country_id": 1939592358,
"country_code": "KW",
"city": "ABBASIYA",
"city_id": 1313869267,
"address_line": "2345,السلام,95128, شارع عبدالله سنابل السلام مكة السعوديه, RIYADH,السعودية",
"street_number": "2345",
"block": "السلام",
"postal_code": "95128",
"latitude": 21.382590509685,
"longitude": 39.773191030685
},
"ship_to": {
"type": "branch",
"name": "Riyadh",
"email": "",
"phone": "0555555555",
"country_id": 1939592358,
"country_code": "KW",
"city": "ABBASIYA",
"city_id": 1313869267,
"address_line": "7687 طريق الملك فهد الفرعي,الملك فهد,12262, 7687 طريق الملك فهد الفرعي، الملك فهد، الرياض 12262 3010، السعودية, الرياض,السعودية",
"street_number": "7687 طريق الملك فهد الفرعي",
"block": "الملك فهد",
"postal_code": "12262",
"latitude": 24.7431373,
"longitude": 46.6570741,
"branch_id": 1723506348
},
"packages": []
},
{
"id": 362985663,
"order_id": 560695739,
"order_reference_id": 48928,
"created_at": {
"date": "2023-01-16 23:37:59.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"type": "return",
"courier_id": 814202285,
"courier_name": "DHL",
"courier_logo": "https://company.com/logo.png",
"shipping_number": "23424234354434",
"tracking_number": "23424234354434",
"pickup_id": null,
"trackable": true,
"tracking_link": "https://www.company/tracking/tracking-express.html?submit=1&tracking-id=12345",
"label": [],
"payment_method": "cod",
"source": "api",
"status": "creating",
"total": {
"amount": 100,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": "10.70",
"currency": "SAR"
},
"meta": {
"app_id": null,
"policy_options": []
},
"ship_from": {
"type": "branch",
"name": "Riyadh",
"email": "",
"phone": "0555555555",
"country": "السعودية",
"country_id": 1939592358,
"country_code": "KW",
"city": "ABBASIYA",
"city_id": 1313869267,
"address_line": "7687 طريق الملك فهد الفرعي,الملك فهد,12262, 7687 طريق الملك فهد الفرعي، الملك فهد، الرياض 12262 3010، السعودية, RIYADH,السعودية",
"street_number": "7687 طريق الملك فهد الفرعي",
"block": "الملك فهد",
"postal_code": "12262",
"latitude": 24.7431373,
"longitude": 46.6570741,
"branch_id": 1723506348
},
"ship_to": {
"type": "address",
"name": "Username",
"email": "[email protected]",
"phone": "055-555-555",
"country": "السعودية",
"country_id": 1939592358,
"country_code": "KW",
"city": "ABBASIYA",
"city_id": 1313869267,
"address_line": " شارع 2345، الحي السلام 95128،, شارع عبدالله سنابل السلام مكة السعوديه,, الرياض, السعودية",
"street_number": "2345",
"block": "السلام",
"postal_code": "95128",
"latitude": 21.382590509685,
"longitude": 39.773191030685
},
"packages": [
{
"name": "منتج تجريبي",
"sku": "6ytrrhrhr",
"price": {
"amount": "50.00",
"currency": "SAR"
},
"quantity": 2,
"weight": {
"value": "1.00",
"unit": "kg"
}
}
]
},
{
"id": 362985660,
"order_id": 560695732,
"order_reference_id": 48922,
"created_at": {
"date": "2023-01-16 23:26:15.000000",
"timezone_type": 3,
"timezone": "Asia/Riyadh"
},
"type": "shipment",
"courier_id": 814202285,
"courier_name": "DHL",
"courier_logo": "https://company.com/logo.png",
"shipping_number": "0",
"tracking_number": "0",
"pickup_id": null,
"trackable": true,
"tracking_link": "https://www.company/tracking/tracking-express.html?submit=1&tracking-id=12345",
"label": [],
"payment_method": "cod",
"source": "api",
"status": "creating",
"total": {
"amount": 100,
"currency": "SAR"
},
"cash_on_delivery": {
"amount": "10.70",
"currency": "SAR"
},
"meta": {
"app_id": null,
"policy_options": {
"boxes": 2
}
},
"ship_from": {
"type": "branch",
"name": "Riyadh",
"email": "",
"phone": "0555555555",
"country": "السعودية",
"country_id": 1939592358,
"country_code": "KW",
"city": "ABBASIYA",
"city_id": 1313869267,
"address_line": "7687 طريق الملك فهد الفرعي,الملك فهد,12262, 7687 طريق الملك فهد الفرعي، الملك فهد، الرياض 12262 3010، السعودية, RIYADH,السعودية",
"street_number": "7687 طريق الملك فهد الفرعي",
"block": "الملك فهد",
"postal_code": "12262",
"latitude": 24.7431373,
"longitude": 46.6570741,
"branch_id": 1723506348
},
"ship_to": {
"type": "address",
"name": "Username",
"email": "[email protected]",
"phone": "055-555-555",
"country": "السعودية",
"country_id": 1939592358,
"country_code": "KW",
"city": "ABBASIYA",
"city_id": 1313869267,
"address_line": " شارع 2345، الحي السلام 95128،, شارع عبدالله سنابل السلام مكة السعوديه,, الرياض, السعودية",
"street_number": "2345",
"block": "السلام",
"postal_code": "95128",
"latitude": 21.382590509685,
"longitude": 39.773191030685
},
"packages": [
{
"name": "منتج تجريبي",
"sku": "6ytrrhrhr",
"price": {
"amount": "50.00",
"currency": "SAR"
},
"quantity": 2,
"weight": {
"value": "1.00",
"unit": "kg"
}
}
]
}
],
"pagination": {
"count": 3,
"total": 32,
"perPage": 3,
"currentPage": 1,
"totalPages": 11,
"links": {
"next": "https://company.com/shipments?page=2"
}
}
}