Delivery zones

Method for retrieving delivery zones (with coordinates).

This method is executed at a scheduled time, usually once
per day. Supports creation of zones with exclusions (holes).

Request

GET

/place-info/v1/zones

Query parameters

Name

Description

origin_id*

Type: string

Identifier of the store in the Partner’s system.

Headers

Name

Description

Authorization*

Type: string

Token received in response to the /security/oauth/token request

Responses

200 OK

Zones retrieved successfully.

Body

application/json

{
    "zones": [
        {
            "coordinates": [
                [
                    {
                        "lt": 56.473673,
                        "lg": 35.918658
                    }
                ]
            ],
            "meta": {
                "zone_id": "123",
                "is_active": false,
                "intervals": [
                    {
                        "weekday": "tuesday",
                        "from": "08:00",
                        "to": "20:00"
                    }
                ],
                "average_delivery_time": 20,
                "thresholds": [
                    {
                        "order_cost": {
                            "currency": "RUB",
                            "value": "350"
                        },
                        "delivery_cost": {
                            "currency": "RUB",
                            "value": "350"
                        }
                    }
                ]
            }
        }
    ]
}

Name

Description

zones*

Type: ZoneV1[]

List of the store’s delivery zones.
Delivery zone.

ZoneV1

Delivery zone.

Name

Description

coordinates*

Type: PointV1[][]

Polygon coordinates.
A set of polygon coordinates. Must contain an ordered list of coordinate points.
Delivery zone coordinate point.

Min items: 1

meta*

Type: ZoneMetaV1

Additional delivery zone data.

PointV1

Delivery zone coordinate point.

Name

Description

lg*

Type: number

Example: 35.918658

lt*

Type: number

Example: 56.473673

ZoneMetaV1

Additional delivery zone data.

Name	Description
average_delivery_time*	Type: integer Average expected delivery time. Example: `20` Min value: `0` Max value: `1440`
intervals*	Type: IntervalV1[] Delivery zone operating hours.
is_active*	Type: boolean Delivery zone activity flag. If the response contains `false`, the zone becomes inactive.
zone_id*	Type: string Delivery zone ID in the Partner’s system. Example: `123` Min length: `1` Max length: `255`
thresholds	Type: ThresholdV1[] Delivery conditions A complex example of delivery conditions with multiple thresholds, where delivery cost depends on basket size. Order from 1000 RUB; cart 1000–1999 RUB, delivery 350 RUB; cart 2000–2999 RUB, delivery 250 RUB; cart from 3000 RUB, delivery is free. `"thresholds": [ { "order_cost": { "currency": "RUB","value": "1000" }, "delivery_cost": { "currency": "RUB","value": "350" } }, { "order_cost": { "currency": "RUB","value": "2000" }, "delivery_cost": { "currency": "RUB","value": "250" } }, { "order_cost": { "currency": "RUB","value": "3000" }, "delivery_cost": { "currency": "RUB","value": "0" } } ]` Delivery conditions. Min items: `1` Max items: `10`

IntervalV1

Name	Description
from*	Type: string Beginning of interval (H:i format) Example: `08:00`
to*	Type: string End of interval (H:i format) Example: `20:00`
weekday*	Type: string Day of week Example: `tuesday` Enum: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`

ThresholdV1

Delivery conditions.

Name

Description

delivery_cost*

Type: MoneyV1

Monetary value representation.

order_cost*

Type: MoneyV1

Monetary value representation.

MoneyV1

Monetary value representation.

Name

Description

currency*

Type: string

Three-letter ISO 4217 currency code.

Example: RUB

Min length: 3

Max length: 3

value*

Type: string

Value in the specified currency (no cents/decimal/comma).

Example: 350

400 Bad Request

Client-side error.

Body

application/json

{
    "message": "string",
    "code": 0,
    "details": {}
}

Name	Description
code*	Type: integer Error code.
message*	Type: string Error message.
details	Type: object

401 Unauthorized

Authorisation failed.

Body

application/json

{
    "message": "string",
    "code": 0,
    "details": {}
}

Name	Description
code*	Type: integer Error code.
message*	Type: string Error message.
details	Type: object

500 Internal Server Error

Server-side error.

Body

application/json

{
    "message": "string",
    "code": 0,
    "details": {}
}

Name	Description
code*	Type: integer Error code.
message*	Type: string Error message.
details	Type: object

Was the article helpful?

Loyalty bonuses

Partner delivery zones meta information