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

<div class="openapi">

# Get the order history

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

Allows receiving information about orders. Orders can be filtered by multiple filters:
    - by order status
    - by order creation date
    - by the service where the order was placed
Limitations:
    - The maximum number of orders in the response - 1000
    - The orders history is stored 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/orders-history
```

</div>

</div>

</div>

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "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
  }
}
```

{% endcut %}

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

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

The date from which Orders should be given. In the RFC 3339 format with a fractional part of seconds (Y-m-d\TH:i:s.uP)

_Example:_{.json-schema-reset .json-schema-example} `2024-01-01T12:00:05.125+03:00`
{.table-cell}
||
||

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

A list of objects. The object consists of the identifier of the restaurant on the partner's side and the type of delivery in this restaurant.

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

```json translate=no
[
  {
    "origin_id": "example",
    "delivery_type": "native"
  }
]
```

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

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

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

```json translate=no
{
  "limit": 0,
  "offset": 0
}
```

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

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

The date before which Orders should be given. In the RFC 3339 format with a fractional part of seconds (Y-m-d\TH:i:s.uP)

_Example:_{.json-schema-reset .json-schema-example} `2024-01-01T12:00:05.125+03:00`
{.table-cell}
||
||

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

List of services to return orders for

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

```json translate=no
[
  "YE"
]
```

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

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

Return orders that match the submitted list statuses

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

```json translate=no
[
  "NEW"
]
```

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

</div>

<div class="openapi-entity">

### OriginIds {#entity-OriginIds}

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

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

restraunt ID in the partner's system

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

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

Delivery type

_Enum:_{.json-schema-reset .json-schema-value} `native`, `marketplace`
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "origin_id": "example",
  "delivery_type": "native"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Service {#entity-Service}

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `YE`, `MD`

</div>

<div class="openapi-entity">

### OrderHistoryStatus {#entity-OrderHistoryStatus}

Oredr status in the Yandex system

**Type**: string | null

_Enum:_{.json-schema-reset .json-schema-value} `NEW`, `CANCELLED`, `DELIVERED`

</div>

<div class="openapi-entity">

### Pagination {#entity-Pagination}

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

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

Offset/pagination. More about pagination on https://slack.engineering/evolving-api-pagination-at-slack/

_Min value:_{.json-schema-reset .json-schema-assertion} `0`
{.table-cell}
||
||

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

Maximum number of orders

_Min value:_{.json-schema-reset .json-schema-assertion} `0`

_Max value:_{.json-schema-reset .json-schema-assertion} `1000`
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "limit": 0,
  "offset": 0
}
```

{% endcut %}

</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",
      "created_at": "2025-01-01T00:00:00Z",
      "status": "NEW",
      "service": "YE",
      "delivery_type": "marketplace",
      "origin_id": "restaurant1",
      "items_cost": 0.5
    }
  ]
}
```

{% endcut %}

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

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

List of orders

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

```json translate=no
[
  {
    "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
  }
]
```

{% 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>

<div class="openapi-entity">

### DeliveryType {#entity-DeliveryType}

Delivery type

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `native`, `marketplace`

</div>

<div class="openapi-entity">

### OriginId {#entity-OriginId}

**Type**: string

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

</div>

<div class="openapi-entity">

### Order {#entity-Order}

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

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

Order creation date

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

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

Delivery type

_Enum:_{.json-schema-reset .json-schema-value} `native`, `marketplace`
{.table-cell}
||
||

_eats_id_{.json-schema-reset .json-schema-property}
{.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_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}
||
||

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

Order identifier on the partners side

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

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

The ID of the restaurant in the partner's system

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

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

A service that facilitated the placement of an order

_Enum:_{.json-schema-reset .json-schema-value} `YE`, `MD`
{.table-cell}
||
||

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

Order status

Oredr status in the Yandex system

_Enum:_{.json-schema-reset .json-schema-value} `NEW`, `CANCELLED`, `DELIVERED`
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "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
}
```

{% 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.