本文档由 Apifox 自动生成，推荐使用 Apifox - API 文档、API 调试、API Mock、API 自动化测试！

List Shipping Zones

Develop Env

https://echo.apifox.com/anything

GET

/shipping/zones

Shipping Zones

Last modified:2025-02-20 07:53:20

Maintainer:Not configured

This endpoint allows you to list all Custom Shipping Zones.

Scopes

shipping.read- Shipping Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

company

number

optional

Shipping Company ID

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

status

number

optional

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.

success

boolean

optional

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.

data

array[object (ShippingZone) {9}]

optional

number

required

A unique identifier associated with a certain shipping zone. List of shipping zons can be found here

Example:

488260393

zone_code

string

required

Zone Code

Example:

.SA.riyadh

company

object

required

country

object

required

city

object

required

cities_excluded

array [object {3}]

required

The cities excluded from Shipping zone.

fees

object

required

cash_on_delivery

object

required

duration

string

required

Shipping duration in days

Example:

3-5

pagination

object (Pagination)

optional

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.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Example

{
    "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"
    }
}

🟠404Record Not Found

🟠401Unauthorized

Create Shipping Zone

Shipping Zone Details