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

Позволяет получать информацию по заказам. Заказы можно фильтровать по нескольким фильтрам:
- Статус заказа
- Дате создания заказа
- Сервису, в котором сделан заказ

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

Примечание

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

Request

POST

/v1/orders-history

Body

application/json

{
    "origin_ids": [
        {
            "origin_id": "string",
            "delivery_type": "native"
        }
    ],
    "service": [
        "YE"
    ],
    "from": "2024-01-01T12:00:05.125+03:00",
    "to": "2024-01-01T12:00:05.125+03:00",
    "status": [
        "NEW"
    ],
    "pagination": {
        "limit": 0,
        "offset": 0
    }
}

Name	Description
from*	Type: string<date-time> Дата, с которой нужно отдать заказы. В формате RFC3339 с дробной частью секунд (Y-m-d\TH:i:s.uP) Example: `2024-01-01T12:00:05.125+03:00`
origin_ids*	Type: OriginIds[] Список объектов. Объект состоит из идентификатора ресторана на стороне партнера и типа доставки в этом ресторане.
pagination*	Type: Pagination
to*	Type: string<date-time> Дата, до которой нужно отдать заказы. В формате RFC3339 с дробной частью секунд (Y-m-d\TH:i:s.uP) Example: `2024-01-01T12:00:05.125+03:00`
service	Type: Service[] Список сервисов, для которых нужно вернуть заказы Enum: `YE`, `MD`
status	Type: OrderHistoryStatus[] Возвращать заказы, соответствующие переданному списку статусов Статус заказа в системе Яндекс.Еды Enum: `NEW`, `CANCELLED`, `DELIVERED`

OriginIds

Name

Description

origin_id*

Type: string

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

delivery_type

Type: string

Тип доставки

Enum: native, marketplace

Pagination

Name

Description

offset*

Type: integer

Смещение/пагинация. Подробней про пагинациюю можно почитать на https://slack.engineering/evolving-api-pagination-at-slack/

Min value: 0

limit

Type: integer

Максимальное число заказов

Min value: 0

Max value: 1000

Service

Type	Description
Service	Enum: `YE`, `MD`

OrderHistoryStatus

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

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

Responses

200 OK

Body

application/json

{
    "orders": [
        {
            "eats_id": "230328-354380",
            "order_id": "string",
            "created_at": "2022-12-29T18:02:01Z",
            "status": "NEW",
            "service": "YE",
            "delivery_type": "marketplace",
            "origin_id": "restaurant1",
            "items_cost": 0,
            "cancel_reason": {
                "code": "place.missing_dish",
                "message": "Заказ был отменён на стороне пользователя"
            }
        }
    ]
}

Name

Description

orders*

Type: Order[]

Список заказов

Order

Name	Description
cancel_reason	Type: CancelReason
created_at	Type: string<date-time> Дата создания заказа
delivery_type	Type: DeliveryType Тип доставки Example: `marketplace` Enum: `native`, `marketplace`
eats_id	Type: string Номер заказа в системе Яндекс.Еда Example: `230328-354380` Min length: `13`
items_cost	Type: number Стоимость заказа для партнера за вычетом стоимости доставки (с учетом партнерских скидок)
order_id	Type: string Номер заказа на стороне партнера
origin_id	Type: string Идентификатор ресторана в системе партнера, из которого был сделан заказ Example: `restaurant1`
service	Type: Service Сервис, через который был сделан заказ Enum: `YE`, `MD`
status	Type: OrderHistoryStatus Статус заказа в системе Яндекс.Еды Enum: `NEW`, `CANCELLED`, `DELIVERED`

CancelReason

Name

Description

code*

Type: string

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

Example: place.missing_dish

message

Type: string

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

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

DeliveryType

Тип доставки

Type

Description

DeliveryType

Example: marketplace

Enum: native, marketplace

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

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

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

Валидация кода курьера

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