List Shipping Zones
GET
/shipping/zonesThis endpoint allows you to list all Custom Shipping Zones.
Request
Shipping Company ID
Request samples
[api.label.responses]
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
A unique identifier associated with a certain shipping zone. List of shipping zons can be found here
Zone Code
The cities excluded from Shipping zone.
Shipping duration in days
For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.
Number of returned results.
Number of all results.
Number of results per page.
Number of current page.
Number of total pages.
Array of linkes to next and previous pages.
{
"status": 200,
"success": true,
"data": {
"id": 1120595191,
"zone_code": ".KW.the-villa",
"company": {
"id": 488260393,
"slug": null
},
"country": {
"id": 1939592358,
"name": "الكويت",
"name_en": "Kuwait",
"code": "KW",
"mobile_code": "+965"
},
"city": {
"id": 1592433390,
"name": "الفيلا",
"name_en": "THE VILLA"
},
"cities_excluded": [
{
"id": 257742554,
"name": "أبو حليفة",
"name_en": "ABU HALIFA"
},
{
"id": 81998629,
"name": "الأحمدي",
"name_en": "AHMADI"
}
],
"fees": {
"amount": "11.00",
"currency": "SAR",
"type": "rate",
"weight_unit": "kg",
"up_to_weight": 5,
"amount_per_unit": 2,
"per_unit": 3
},
"cash_on_delivery": {
"status": true,
"fees": "12.00"
},
"duration": "13 days"
}
}