Детальная информация о заказах

Позволяет получать подробную информацию по заказам.

Ограничения метода:
- В запросе можно передать не более 100 заказов
- История хранится для заказов за последние 180 дней

Примечание

Метод доступен только по подписке.

Request

POST

/v1/get-orders-details

Body

application/json

{
    "eats_ids": [
        "230328-354380"
    ]
}

Name

Description

eats_ids*

Type: string[]

Список номеров заказов для поиска
Номер заказа в системе Яндекс.Еда

Example: 230328-354380

Min length: 13

Min items: 1

Max items: 100

Responses

200 OK

Body

application/json

{
    "orders": [
        {
            "eats_id": "230328-354380",
            "order_id": "string",
            "status": "NEW",
            "items": [
                {
                    "id": "string",
                    "name": "string",
                    "quantity": 3.5,
                    "price": 123.78,
                    "original_price": 100.23,
                    "weight": 0,
                    "measure_unit": "string",
                    "modifications": [
                        {
                            "id": "string",
                            "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
                            "name": "string",
                            "quantity": 0,
                            "price": 10.5
                        }
                    ]
                }
            ],
            "items_cost": 0,
            "cancel_reason": {
                "code": "place.missing_dish",
                "message": "Заказ был отменён на стороне пользователя"
            }
        }
    ],
    "not_found_eats_ids": [
        "230328-354380"
    ]
}

Name

Description

not_found_eats_ids*

Type: string[]

Список номеров заказов, по которым информация не найдена или недоступна
Номер заказа в системе Яндекс.Еда

Example: 230328-354380

Min length: 13

orders*

Type: OrderDetails[]

Список заказов с детальной информацией
Заказ с детальной информацией

OrderDetails

Заказ с детальной информацией

Name	Description
eats_id*	Type: string Номер заказа в системе Яндекс.Еда Example: `230328-354380` Min length: `13`
items*	Type: OrderStatusPut[] Состав заказа Товар с опциями
order_id*	Type: string Идентификатор заказа в системе партнера
status*	Type: OrderHistoryStatus Статус заказа в системе Яндекс.Еды Enum: `NEW`, `CANCELLED`, `DELIVERED`
cancel_reason	Type: CancelReason
items_cost	Type: number Стоимость заказа для партнера за вычетом стоимости доставки (с учетом партнерских скидок)

OrderStatusPut

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`

OrderHistoryStatus

Статус заказа в системе Яндекс.Еды

Type	Description
OrderHistoryStatus	Enum: `NEW`, `CANCELLED`, `DELIVERED`

CancelReason

Name

Description

code*

Type: string

Код причины отмены заказа в Яндекс Еда

Example: place.missing_dish

message

Type: string

Текст причины отмены заказа

Example: Заказ был отменён на стороне пользователя

400 Bad Request

Ошибка запроса

Body

application/json

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

Name

Description

code*

Type: string

Код ошибки

message*

Type: string

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

500 Internal Server Error

Ошибка сервиса

Body

application/json

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

Name

Description

code*

Type: string

Код ошибки

message*

Type: string

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

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

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

Получение списка ресторанов с активным статусом высокого спроса