Shipping Zone Details

This endpoint allows you to fetch a specific Custom Shipping Zone by passing the zone_id as a path parameter.

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 ********************

Path Params

zone_id

integer

required

Unique identifier assigned to a shipping zone, list of shipping companies can be found here.

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

object (ShippingZone)

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

A short alphanumeric identification code for a zone.

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

Example

{
    "status": 200,
    "success": true,
    "data": {
        "id": 488260393,
        "zone_code": ".SA.riyadh",
        "company": {
            "id": 1473353380,
            "slug": "ABU HALIFA"
        },
        "country": {
            "id": 1473353380,
            "name": "السعودية",
            "name_en": "Saudi Arabia",
            "code": "SA",
            "mobile_code": "+966"
        },
        "city": {
            "id": 1473353380,
            "name": "الرياض",
            "name_en": "Riyadh"
        },
        "cities_excluded": [
            {
                "id": 257742554,
                "name": "أبو حليفة",
                "name_en": "ABU HALIFA"
            }
        ],
        "fees": {
            "amount": "15.00",
            "currency": "SAR",
            "type": "fixed"
        },
        "cash_on_delivery": {
            "status": true,
            "fees": "12.00"
        },
        "duration": "3-5"
    }
}

🟠401Unauthorized

Request

Request samples

Responses