Get restaurant's delivery zones

The method of creating delivery zones in Yandex systems. It works according to a schedule (by default, once a day at 9:00, it is possible to change/extend the request interval in agreement with Yandex).

Note

This method is only available by subscription.

Request

GET

/places/{restaurantId}/zones

Path parameters

Name

Description

restaurantId*

Type: string

The ID of the restaurant in the partner's system

Responses

200 OK

Sucsess

Body

application/json

[
    {
        "coordinates": [
            {
                "lt": 56.473673,
                "lg": 35.918658
            }
        ],
        "meta": {
            "zoneId": "string",
            "enabled": false,
            "intervals": {
                "mon": [
                    {
                        "start": "00:00",
                        "end": "24:00"
                    }
                ],
                "tue": [
                    {
                        "start": "00:00",
                        "end": "24:00"
                    }
                ],
                "wed": [
                    {
                        "start": "00:00",
                        "end": "24:00"
                    }
                ],
                "thu": [
                    {
                        "start": "00:00",
                        "end": "24:00"
                    }
                ],
                "fri": [
                    {
                        "start": "00:00",
                        "end": "24:00"
                    }
                ],
                "sat": [
                    {
                        "start": "00:00",
                        "end": "24:00"
                    }
                ],
                "sun": [
                    {
                        "start": "00:00",
                        "end": "24:00"
                    }
                ]
            },
            "averageDeliveryTime": 0,
            "thresholds": [
                {
                    "orderCost": {
                        "currency": "SUM",
                        "value": 0
                    },
                    "deliveryCost": {
                        "currency": "SUM",
                        "value": 0
                    }
                }
            ],
            "courierType": "pedestrian"
        },
        "name": "string"
    }
]

Zone[]

Zone

Delivery area

Name	Description
coordinates*	Type: Point[] The set of coordinates of the polygon must contain an ordered a set of coordinate points The coordinate point of the zone Min length: `4` Max length: `500`
meta*	Type: ZoneMeta Additional data of delivery zones
name*	Type: string Delivery zone name Min length: `1` Max length: `255`

Point

The coordinate point of the zone

Name

Description

lg*

Type: number

Example: 35.918658

lt*

Type: number

Example: 56.473673

ZoneMeta

Additional data of delivery zones

Name	Description
averageDeliveryTime*	Type: number Average waiting time for delivery
enabled*	Type: boolean The boolean flag of the Delivery zone activity. When received in response `false` - the zone will become inactive.
intervals*	Type: Intervals Delivery zones opening hours
thresholds*	Type: Threshold[] Terms of delivery Terms of delivery Min length: `1` Max length: `10`
zoneId*	Type: string Delivery zone ID in the partner's system Min length: `1` Max length: `255`
courierType	Type: string Enum: `pedestrian`, `bicycle`, `vehicle`, `motorcycle`

Intervals

Delivery zones opening hours

Name	Description
fri*	Type: Interval[] Opening hours for Friday, leave an empty array for non-working days The interval of working hours. Specify 00:00-24:00 for round-the-clock zones. Opening hours are indicated according to the local timezone of the restaurant.
mon*	Type: Interval[] Opening hours for Monday, leave an empty array for non-working days The interval of working hours. Specify 00:00-24:00 for round-the-clock zones. Opening hours are indicated according to the local timezone of the restaurant.
sat*	Type: Interval[] Opening hours for Saturday, leave an empty array for non-working days The interval of working hours. Specify 00:00-24:00 for round-the-clock zones. Opening hours are indicated according to the local timezone of the restaurant.
sun*	Type: Interval[] Opening hours for Sunday, leave an empty array for non-working days The interval of working hours. Specify 00:00-24:00 for round-the-clock zones. Opening hours are indicated according to the local timezone of the restaurant.
thu*	Type: Interval[] Opening hours for Thursday, leave an empty array for non-working days The interval of working hours. Specify 00:00-24:00 for round-the-clock zones. Opening hours are indicated according to the local timezone of the restaurant.
tue*	Type: Interval[] Opening hours for Tuesday, leave an empty array for non-working days The interval of working hours. Specify 00:00-24:00 for round-the-clock zones. Opening hours are indicated according to the local timezone of the restaurant.
wed*	Type: Interval[] Opening hours for Wednesday, leave an empty array for non-working days The interval of working hours. Specify 00:00-24:00 for round-the-clock zones. Opening hours are indicated according to the local timezone of the restaurant.

Threshold

Terms of delivery

Name

Description

deliveryCost*

Type: Money

The cost of delivery. Specify 0 for free shipping

orderCost*

Type: Money

Minimum order amount for delivery

Interval

The interval of working hours. Specify 00:00-24:00 for round-the-clock zones. Opening hours are indicated according to the local timezone of the restaurant.

Name

Description

end*

Type: string

Period end time in HH:MM format

Example: 24:00

Min length: 5

Max length: 5

start*

Type: string

The start time of the period in the HH:MM format

Example: 00:00

Min length: 5

Max length: 5

Money

Presentation of the amount of money

Name

Description

currency*

Type: string

Three-letter currency designation ISO 4217

Example: SUM

Min length: 3

Max length: 3

value*

Type: number

The value in the specified currency

Example: 0

Min value: 0

400 Bad Request

Error in the parameters, the response contains a list of validation errors

Body

application/json

[
    {
        "code": 100,
        "description": "Description of error"
    }
]

OrderStatusPut[]

OrderStatusPut

Name	Description
status*	Type: string Order ststus. Status description: TAKEN_BY_COURIER - courier picked up the order from the restaurant. DELIVERED – order completed. CANCELLED – order cancelled. Enum: `CANCELLED`, `TAKEN_BY_COURIER`, `DELIVERED`
attributes	Type: string[] Additional attributes when changing the order status, for example, a sign of payment upon cancellation Example: `paid`
comment	Type: string Description of cancellation reasons (can be empty) Example: `test` Max length: `500`
reason	Type: string The reason for the cancellation of the order. It is transmitted only with the CANCELLED status Example: `place.unable_to_call`
updatedAt	Type: string The date when the order status changed, in RFC 3339 format with fractional part of seconds (Y-m-d\TH:i:s.uP) Example: `1937-01-01T12:00:27.870000+00:20`

401 Unauthorized

Authorization failed - the token expired or was not passed in the request. A retry will be made

Body

application/json

{
    "reason": "Access token has been expired. You should request a new one"
}

Name

Description

reason*

Type: string

Reason for authorization failure

Example: Access token has been expired. You should request a new one

500 Internal Server Error

Internal server errors

Body

application/json

[
    {
        "code": 100,
        "description": "Description of error"
    }
]

OrderStatusPut[]

Was the article helpful?

Overview

Get delivery data to update information in delivery areas