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

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

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

Request

POST

/v1/get-orders-details

Body

application/json

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

Name

Description

eats_ids

Type: EatsId[]

Список номеров заказов для поиска

Min items: 1

Max items: 100

Example

[
  "230328-354380"
]

EatsId

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

Type: string

Min length: 13

Example: 230328-354380

Responses

200 OK

Body

application/json

{
  "orders": [
    {
      "eats_id": "230328-354380",
      "order_id": "example",
      "status": "NEW",
      "items": [
        {
          "id": "example",
          "name": "example",
          "quantity": 3.5,
          "price": 123.78,
          "original_price": 100.23,
          "weight": 0.5,
          "measure_unit": "example",
          "modifications": [
            null
          ]
        }
      ],
      "items_cost": 0.5,
      "cancel_reason": {
        "code": "place.missing_dish",
        "message": "Заказ был отменён на стороне пользователя"
      }
    }
  ],
  "not_found_eats_ids": [
    null
  ]
}

Name

Description

not_found_eats_ids

Type: EatsId[]

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

Example

[
  "230328-354380"
]

orders

Type: OrderDetails[]

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

Example

[
  {
    "eats_id": "230328-354380",
    "order_id": "example",
    "status": "NEW",
    "items": [
      {
        "id": "example",
        "name": "example",
        "quantity": 3.5,
        "price": 123.78,
        "original_price": 100.23,
        "weight": 0.5,
        "measure_unit": "example",
        "modifications": [
          {}
        ]
      }
    ],
    "items_cost": 0.5,
    "cancel_reason": {
      "code": "place.missing_dish",
      "message": "Заказ был отменён на стороне пользователя"
    }
  }
]

OrderHistoryStatus

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

Type: string | null

Enum: NEW, CANCELLED, DELIVERED

OrderItemOption

Опция товара

Name	Description
id	Type: string Идентификатор опции на стороне ресторана/магазина Example: `example`
price	Type: number Цена опции товара
quantity	Type: integer Количество опций в рамках этой позиции
group_id	Type: string ID группы в системе партнера, к которой принадлежит опция Example: `937c57f6-4508-4858-be7f-20691a16fbb1`
name	Type: string Название опции Example: `example`

Example

{
  "id": "example",
  "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
  "name": "example",
  "quantity": 0,
  "price": 10.5
}

OrderItem

Товар с опциями

Name	Description
id	Type: string Идентификатор товара на стороне ресторана/магазина Example: `example`
measure_unit	Type: string Единицы измерения веса, например GRM Example: `example`
modifications	Type: OrderItemOption[] Опции товара Example `[ { "id": "example", "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1", "name": "example", "quantity": 0, "price": 10.5 } ]`
name	Type: string Название товара, например «Картошка» Example: `example`
original_price	Type: number Стоимость одной данной позиции без учета стоимости опций
price	Type: number Стоимость одной данной позиции вместе со стоимостью опций
quantity	Type: number Количество товаров в рамках этой позиции
weight	Type: number Конечный вес товара

Example

{
  "id": "example",
  "name": "example",
  "quantity": 3.5,
  "price": 123.78,
  "original_price": 100.23,
  "weight": 0.5,
  "measure_unit": "example",
  "modifications": [
    {
      "id": "example",
      "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
      "name": "example",
      "quantity": 0,
      "price": 10.5
    }
  ]
}

CancelReason

Name

Description

code

Type: string

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

Example: place.missing_dish

message

Type: string

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

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

Example

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

OrderDetails

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

Name	Description
eats_id	Type: EatsId Номер заказа в системе Яндекс.Еда Min length: `13` Example: `230328-354380`
items	Type: OrderItem[] Состав заказа Example `[ { "id": "example", "name": "example", "quantity": 3.5, "price": 123.78, "original_price": 100.23, "weight": 0.5, "measure_unit": "example", "modifications": [ { "id": "example", "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1", "name": "example", "quantity": 0, "price": 10.5 } ] } ]`
order_id	Type: string \| null Идентификатор заказа в системе партнера Example: `example`
status	Type: OrderHistoryStatus Статус заказа в системе Яндекс.Еды Enum: `NEW`, `CANCELLED`, `DELIVERED`
cancel_reason	Type: CancelReason Example `{ "code": "place.missing_dish", "message": "Заказ был отменён на стороне пользователя" }`
items_cost	Type: number Стоимость заказа для партнера за вычетом стоимости доставки (с учетом партнерских скидок)

Example

{
  "eats_id": "230328-354380",
  "order_id": "example",
  "status": "NEW",
  "items": [
    {
      "id": "example",
      "name": "example",
      "quantity": 3.5,
      "price": 123.78,
      "original_price": 100.23,
      "weight": 0.5,
      "measure_unit": "example",
      "modifications": [
        {
          "id": "example",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "example",
          "quantity": 0,
          "price": 10.5
        }
      ]
    }
  ],
  "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

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

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

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