---
metadata:
  - name: generator
    content: Diplodoc Platform v5.48.2
alternate:
  - https://yandex.com/dev/eda-vendor/doc/en/ref/Vendor-Management-Integration-API/partner.integration.v1.get.orders.details.post.md
  - https://yandex.com/dev/eda-vendor/doc/ru/ref/Vendor-Management-Integration-API/partner.integration.v1.get.orders.details.post.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/eda-vendor/doc/en/llms.txt

<div class="openapi">

# Detailed information about orders

<!-- markdownlint-disable-file -->

Retrieve Detailed Order Information.

Limitations:
    - A maximum of 100 orders can be sent in a request
    - The history is stored for orders for the last 180 days


## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-post);margin-bottom: 12px">

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
/v1/get-orders-details
```

</div>

</div>

</div>

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "eats_ids": [
    "230328-354380"
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_eats_ids_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [EatsId](#entity-EatsId)[]

List of order numbers to search for

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

_Max items:_{.json-schema-reset .json-schema-assertion} `100`

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "230328-354380"
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### EatsId {#entity-EatsId}

End-to-end order identifier on the Yandex side in the format DDDDDD-DDDDDDDD

**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `13`

_Example:_{.json-schema-reset .json-schema-example} `230328-354380`

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "orders": [
    {
      "eats_id": "230328-354380",
      "order_id": "example",
      "status": {
        "status": "NEW",
        "comment": "New order",
        "updatedAt": "1937-01-01T12:00:27.870000+00:20"
      },
      "items": [
        {
          "id": "example",
          "name": "example",
          "quantity": 0.5,
          "price": 123.78,
          "original_price": 100.23,
          "weight": 0.5,
          "measure_unit": "example",
          "modifications": [
            null
          ]
        }
      ],
      "items_cost": 0.5
    }
  ],
  "not_found_eats_ids": [
    null
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_not_found_eats_ids_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [EatsId](#entity-EatsId)[]

List of order numbers for which information not found or unavailable

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "230328-354380"
]
```

{% endcut %}
{.table-cell}
||
||

_orders_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderDetails](#entity-OrderDetails)[]

List of orders with detailed information

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "eats_id": "230328-354380",
    "order_id": "example",
    "status": {
      "status": "NEW",
      "comment": "New order",
      "updatedAt": "1937-01-01T12:00:27.870000+00:20"
    },
    "items": [
      {
        "id": "example",
        "name": "example",
        "quantity": 0.5,
        "price": 123.78,
        "original_price": 100.23,
        "weight": 0.5,
        "measure_unit": "example",
        "modifications": [
          {}
        ]
      }
    ],
    "items_cost": 0.5
  }
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### OrderStatus {#entity-OrderStatus}

#|
|| **Name** | **Description** ||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Order status. Must be valid – for example, a prepared order cannot be made
new again. Status transition is only possible in the specified direction:
from NEW to DELIVERED. Exceptions: the order can move to the CANCELLED

Status description:

- NEW – new, just sent to the restaurant.
- ACCEPTED_BY_RESTAURANT – order confirmed by the restaurant.
- COOKING – order preparation started.
- READY – order prepared.
- TAKEN_BY_COURIER – courier picked up the order from the restaurant.
- DELIVERED – order completed.
- CANCELLED – order cancelled.

NEW -> ACCEPTED_BY_RESTAURANT -> COOKING -> READY ->
TAKEN_BY_COURIER -> DELIVERED. From any status -> CANCELLED


_Enum:_{.json-schema-reset .json-schema-value} `NEW`, `ACCEPTED_BY_RESTAURANT`, `COOKING`, `READY`, `TAKEN_BY_COURIER`, `DELIVERED`, `CANCELLED`
{.table-cell}
||
||

_comment_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Status change comment

_Max length:_{.json-schema-reset .json-schema-assertion} `500`

_Example:_{.json-schema-reset .json-schema-example} `New order`
{.table-cell}
||
||

_updatedAt_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Date when the order status changed, in RFC3339 format with fractional seconds (Y-m-d\TH:i:s.uP)

_Example:_{.json-schema-reset .json-schema-example} `1937-01-01T12:00:27.870000+00:20`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "status": "NEW",
  "comment": "New order",
  "updatedAt": "1937-01-01T12:00:27.870000+00:20"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderItemOption {#entity-OrderItemOption}

Product Option

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Option's ID in the partner's system

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_price_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number

The price of a product option
{.table-cell}
||
||

_quantity_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

The number of options within the item
{.table-cell}
||
||

_group_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

The ID of the group in the partner system to which the option belongs

_Example:_{.json-schema-reset .json-schema-example} `937c57f6-4508-4858-be7f-20691a16fbb1`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Option name

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

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

{% endcut %}

</div>

<div class="openapi-entity">

### OrderItem {#entity-OrderItem}

Item with modificators

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Item ID on the partner's system

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_measure_unit_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Units of weight measurement

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_modifications_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrderItemOption](#entity-OrderItemOption)[]

Product Options

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
    "name": "example",
    "quantity": 0,
    "price": 10.5
  }
]
```

{% endcut %}
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Item name

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_original_price_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number

The cost of a given item excluding the cost of options
{.table-cell}
||
||

_price_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number

The cost of a given item including the cost of options
{.table-cell}
||
||

_quantity_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number

The number of products within this item
{.table-cell}
||
||

_weight_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number

Final weight of the product
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "name": "example",
  "quantity": 0.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
    }
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderDetails {#entity-OrderDetails}

Order with detailed information

#|
|| **Name** | **Description** ||
||

_eats_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [EatsId](#entity-EatsId)

End-to-end order identifier on the Yandex side in the format DDDDDD-DDDDDDDD

_Min length:_{.json-schema-reset .json-schema-assertion} `13`

_Example:_{.json-schema-reset .json-schema-example} `230328-354380`
{.table-cell}
||
||

_items_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderItem](#entity-OrderItem)[]

The composition of the order

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "name": "example",
    "quantity": 0.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
      }
    ]
  }
]
```

{% endcut %}
{.table-cell}
||
||

_order_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string &#124; null

Order identifier in the partner's system

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [OrderStatus](#entity-OrderStatus)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "status": "NEW",
  "comment": "New order",
  "updatedAt": "1937-01-01T12:00:27.870000+00:20"
}
```

{% endcut %}
{.table-cell}
||
||

_items_cost_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number

The cost of the order for the partner minus the cost delivery (including partner discounts)
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "eats_id": "230328-354380",
  "order_id": "example",
  "status": {
    "status": "NEW",
    "comment": "New order",
    "updatedAt": "1937-01-01T12:00:27.870000+00:20"
  },
  "items": [
    {
      "id": "example",
      "name": "example",
      "quantity": 0.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
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Request error

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "message": "example",
  "code": "example"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error code

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error message

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

Internal server error

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "message": "example",
  "code": "example"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error code

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Error message

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.