❗️Order status update initiated by Yango Deli

Method used for order cancellation from Yandex Eats side, also transmitted when receiving CANCELLED status from Partner.
Transmitting TAKEN_BY_COURIER and/or DELIVERED statuses requires approval by Yandex employees.

Note

Content-type header differs between request and response.

Request

PUT

/order/{orderId}/status

Path parameters

Name

Description

orderId*

Type: string

Order identifier in Partner’s system.

Headers

Name

Description

Authorization*

Type: string

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

Body

application/vnd.eats.order.status.v1+json

{
    "attributes": [
        "paid"
    ],
    "comment": "string",
    "reason": "place.unable_to_call",
    "status": "string",
    "updatedAt": "1970-01-01T00:00:27.870000+00:20",
    "platform": "YE"
}

Name	Description
status*	Type: string Order status. Possible values: TAKEN_BY_COURIER – courier picked up the order from the store. DELIVERED – order completed. CANCELLED – order cancelled.
attributes	Type: string[] Additional attributes for order status change, e.g., payment flag on cancellation. Example: `paid`
comment	Type: string Comment for the order status change Example: `string`
platform	Type: Platform Platform identifier, DC – Delivery Club, YE – Yandex Eats, LAVKA – Lavka, VSEAPTEKI – Vseapteki. Example: `YE` Enum: `YE`, `DC`, `LAVKA`, `VSEAPTEKI`
reason	Type: string Reason for order cancellation. Provided only when status is `CANCELLED`. Possible values: place.unable_to_call place.missing_dish place.closed_early place.technical_problem place.busy_period place.some_other_reason place.integration_failed place.late client.does_not_want_to_wait client.refused_order_changes place.high_load service.integration_failed other Example: `place.unable_to_call`
updatedAt	Type: string<date-time> Date when the order status changed, in RFC3339 format with fractional seconds (Y-m-d\TH:i:s.uP). Example: `1970-01-01T00:00:27.870000+00:20`

Platform

Platform identifier, DC – Delivery Club, YE – Yandex Eats, LAVKA – Lavka, VSEAPTEKI – Vseapteki.

Type

Description

Platform

Example: YE

Enum: YE, DC, LAVKA, VSEAPTEKI

Responses

204 No Content

Order status successfully updated.

400 Bad Request

Bad request. Parameter error, response is expected to contain an array with a validation error list object.

Body

application/json

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

ErrorItem[]

ErrorItem

Name

Description

code*

Type: integer

Numeric error code agreed with Yango Deli.

Example: 400

description*

Type: string

Error description

Example: Description of error

401 Unauthorized

Authorisation failed – token expired or not provided in request.

Body

application/json

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

Name

Description

reason*

Type: string

The reason why authorisation failed.

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

404 Not Found

Order not found. The response is expected to contain an array with a data object.

Body

application/json

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

ErrorItem[]

500 Internal Server Error

Internal server errors. The response is expected to contain an array with an object from the error list.

Body

application/json

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

ErrorItem[]

Was the article helpful?

❗️Order status

Courier notifications