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

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

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

Request

POST

/v1/orders-history

Body

application/json
{
  "origin_ids": [
    {
      "origin_id": "example",
      "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[]

Список объектов. Объект состоит из идентификатора ресторана на стороне партнера и типа доставки в этом ресторане.

Example
[
  {
    "origin_id": "example",
    "delivery_type": "native"
  }
]

pagination

Type: Pagination

Example
{
  "limit": 0,
  "offset": 0
}

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[]

Список сервисов, для которых нужно вернуть заказы

Example
[
  "YE"
]

status

Type: OrderHistoryStatus[]

Возвращать заказы, соответствующие переданному списку статусов

Example
[
  "NEW"
]

OriginIds

Name

Description

origin_id

Type: string

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

Example: example

delivery_type

Type: string

Тип доставки

Enum: native, marketplace
Example
{
  "origin_id": "example",
  "delivery_type": "native"
}

Service

Type: string

Enum: YE, MD

OrderHistoryStatus

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

Type: string | null

Enum: NEW, CANCELLED, DELIVERED

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
Example
{
  "limit": 0,
  "offset": 0
}

Responses

200 OK

OK

Body

application/json
{
  "orders": [
    {
      "eats_id": "230328-354380",
      "order_id": "example",
      "created_at": "2025-01-01T00:00:00Z",
      "status": "NEW",
      "service": "YE",
      "delivery_type": "marketplace",
      "origin_id": "restaurant1",
      "items_cost": 0.5,
      "cancel_reason": {
        "code": "place.missing_dish",
        "message": "Заказ был отменён на стороне пользователя"
      }
    }
  ]
}

Name

Description

orders

Type: Order[]

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

Example
[
  {
    "eats_id": "230328-354380",
    "order_id": "example",
    "created_at": "2025-01-01T00:00:00Z",
    "status": "NEW",
    "service": "YE",
    "delivery_type": "marketplace",
    "origin_id": "restaurant1",
    "items_cost": 0.5,
    "cancel_reason": {
      "code": "place.missing_dish",
      "message": "Заказ был отменён на стороне пользователя"
    }
  }
]

EatsId

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

Type: string

Min length: 13

Example: 230328-354380

DeliveryType

Тип доставки

Type: string

Enum: native, marketplace

OriginId

Type: string

Example: restaurant1

CancelReason

Name

Description

code

Type: string

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

Example: place.missing_dish

message

Type: string

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

Example: Заказ был отменён на стороне пользователя
Example
{
  "code": "place.missing_dish",
  "message": "Заказ был отменён на стороне пользователя"
}

Order

Name

Description

cancel_reason

Type: CancelReason

Example
{
  "code": "place.missing_dish",
  "message": "Заказ был отменён на стороне пользователя"
}

created_at

Type: string<date-time>

Дата создания заказа

Example: 2025-01-01T00:00:00Z

delivery_type

Type: DeliveryType

Тип доставки

Enum: native, marketplace

eats_id

Type: EatsId

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

Min length: 13

Example: 230328-354380

items_cost

Type: number

Стоимость заказа для партнера за вычетом стоимости доставки (с учетом партнерских скидок)

order_id

Type: string

Номер заказа на стороне партнера

Example: example

origin_id

Type: OriginId

Идентификатор ресторана в системе партнера, из которого был сделан заказ

Example: restaurant1

service

Type: Service

Сервис, через который был сделан заказ

Enum: YE, MD

status

Type: OrderHistoryStatus

Статус заказа

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

Enum: NEW, CANCELLED, DELIVERED
Example
{
  "eats_id": "230328-354380",
  "order_id": "example",
  "created_at": "2025-01-01T00:00:00Z",
  "status": "NEW",
  "service": "YE",
  "delivery_type": "marketplace",
  "origin_id": "restaurant1",
  "items_cost": 0.5,
  "cancel_reason": {
    "code": "place.missing_dish",
    "message": "Заказ был отменён на стороне пользователя"
  }
}

400 Bad Request

Неуспешная валидация

Body

application/json
{
  "message": "example",
  "code": "example"
}

Name

Description

code

Type: string

Код ошибки

Example: example

message

Type: string

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

Example: example

500 Internal Server Error

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

Body

application/json
{
  "message": "example",
  "code": "example"
}

Name

Description

code

Type: string

Код ошибки

Example: example

message

Type: string

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

Example: example
Предыдущая
Валидация кода курьера
Следующая
Детальная информация о заказах