Update Shipping Zone - Salla Merchants APIs

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

Note

If you ship to all countries and cities, set the country and city IDs to "-1". When set this way, the code and mobile_code variables will be excluded from the response.

Scopes

shipping.read_write- Shipping Read & Write

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

string

required

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

Body Params application/json

company

number

required

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

shipping

object

optional

Shipping details.

country

number

required

Unique identification number assigned to Shipping Country. If you ship to all countries, ensure that you set the value to -1. List of countries can be found here.

city

number

required

Unique identification number assigned to Shipping City. If you ship to all cities, ensure that you set the value to -1. List of cities can be found here.

cities_excluded

array[number] | number

optional

Excluded Cities from Shipping. List of cities can be found here.

cash_on_delivery

object

optional

Excluded City Name in English. List of cities can be found here.

fees

object

required

Fees details.

duration

string

required

Shipping duration in days

Example

{
    "company": 488260393,
    "shipping": {
        "country": 1939592358,
        "city": 1592433390,
        "cities_excluded": [
            257742554,
            81998629
        ],
        "cash_on_delivery": {
            "fees": 12,
            "status": true
        },
        "fees": {
            "type": "rate",
            "amount": 11,
            "up_to_weight": 5,
            "amount_per_unit": 2,
            "per_unit": 3
        },
        "duration": "13 days"
    }
}

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

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",
            "weight_unit": "kg",
            "up_to_weight": 5,
            "amount_per_unit": 2,
            "per_unit": 3
        },
        "cash_on_delivery": {
            "status": true,
            "fees": "12.00"
        },
        "duration": "3-5"
    }
}

🟠400Bad Request

🟠401Unauthorized