Обновление статуса заказа со стороны Яндекс.Еды

Обновление статуса заказа в системе партнера по инициативе Яндекс Еды. В общем случае отмену заказа Яндекс Еда передает через метод DELETE /order/

Request

PUT

/order/{orderId}/status

Path parameters

Name

Description

orderId*

Type: string

Идентификатор заказа в системе партнера

Body

application/json

{
    "status": "CANCELLED",
    "attributes": [
        "paid"
    ],
    "comment": "test",
    "reason": "place.unable_to_call",
    "updatedAt": "1937-01-01T12:00:27.870000+00:20"
}

Name	Description
status*	Type: string Статус заказа. Описание статусов: TAKEN_BY_COURIER - курьер забрал заказ из ресторана. DELIVERED - заказ завершен. CANCELLED - заказ отменён. Enum: `CANCELLED`, `TAKEN_BY_COURIER`, `DELIVERED`
attributes	Type: string[] Дополнительные аттрибуты при изменении статуса заказа, например признак оплаты при отмене Example: `paid`
comment	Type: string Комментарий к смене статуса Example: `test` Max length: `500`
reason	Type: string Причина отмены заказа. Передается только со статусом CANCELLED Example: `place.unable_to_call`
updatedAt	Type: string Дата, когда сменился статус заказа, в формате RFC3339 с дробной частью секунд (Y-m-d\TH:i:s.uP) Example: `1937-01-01T12:00:27.870000+00:20`

Responses

204 No Content

Статус заказа успешно обновлен

400 Bad Request

Bad request. Ошибка в параметрах. В теле ответа ожидается массив с объектом из списка ошибок

Body

application/json

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

ErrorItem[]

ErrorItem

Name

Description

code

Type: integer

Согласованный с Яндекс.Еда числовой код ошибки

Example: 100

description

Type: string

Сообщение об ошибке

Example: Description of error

401 Unauthorized

Не пройдена авторизация - истек токен, либо не был передан в запросе. Будет сделан ретрай

Body

application/json

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

Name

Description

reason*

Type: string

Причина, по которой не прошла авторизация

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

404 Not Found

Заказ не найден в системе. В теле ответа ожидается массив с объектом из списка ошибок

Body

application/json

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

ErrorItem[]

500 Internal Server Error

Внутренние ошибки сервера. В теле ответа ожидается массив с объектом из списка ошибок

Body

application/json

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

ErrorItem[]

Была ли статья полезна?

Получить статус заказа в системе ресторана

Обновить информацию про курьера