---
metadata:
  - name: generator
    content: Diplodoc Platform v5.48.2
alternate:
  - https://yandex.com/dev/eda-vendor/doc/en/ref/Orders/partner.order.create.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/eda-vendor/doc/en/llms.txt

<div class="openapi">

# Create an order in the restaurant system

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

* `YandexOrder` – order schema for Yandex delivery.
* `MarketplaceOrder` – order schema for partner delivery.
* `PickupOrder` – order schema for pickup orders by customer.

Current version of the request model – application/vnd.eats.order.v2+json.


## 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
/order
```

</div>

</div>

</div>

<div class="openapi-entity">

### Body

{% cut "application/vnd.eats.order.v2+json" %}

```json translate=no
{
  "platform": "YE",
  "discriminator": "yandex",
  "eatsId": "190330-12345678",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "John Cena",
    "phoneNumber": "+79031111111 ext. 4432",
    "additionalPhoneNumbers": [
      null
    ],
    "courierArrivementDate": "1937-01-01T12:00:27.870000+00:20",
    "realPhoneNumber": "+79031111111",
    "pickupCode": "123"
  },
  "paymentInfo": {
    "itemsCost": 100,
    "paymentType": "CARD"
  },
  "items": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "name": "Pepperoni Pizza",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {}
      ],
      "promos": [
        {}
      ]
    }
  ],
  "persons": 2,
  "comment": "Additional order information: ...",
  "promos": [
    {}
  ]
}
```

{% endcut %}

{% cut "**One of 3 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [YandexOrderV2](#entity-YandexOrderV2)

  Current version of the order model for "Yandex" delivery scheme.

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

  ```json translate=no
  {
    "platform": "YE",
    "discriminator": "yandex",
    "eatsId": "190330-12345678",
    "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "deliveryInfo": {
      "clientName": "John Cena",
      "phoneNumber": "+79031111111 ext. 4432",
      "additionalPhoneNumbers": [
        null
      ],
      "courierArrivementDate": "1937-01-01T12:00:27.870000+00:20",
      "realPhoneNumber": "+79031111111",
      "pickupCode": "123"
    },
    "paymentInfo": {
      "itemsCost": 100,
      "paymentType": "CARD"
    },
    "items": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "name": "Pepperoni Pizza",
        "quantity": 3.5,
        "price": 100,
        "modifications": [
          {
            "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
            "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
            "name": "utensils",
            "quantity": 3,
            "price": 100
          }
        ],
        "promos": [
          {
            "type": "GIFT",
            "discount": 200,
            "partner_discount": 100,
            "yandex_discount": 100
          }
        ]
      }
    ],
    "persons": 2,
    "comment": "Additional order information: ...",
    "promos": [
      {}
    ]
  }
  ```

  {% endcut %}

- **Type**: [MarketplaceOrderV2](#entity-MarketplaceOrderV2)

  Current version of the order model for "Marketplace" delivery scheme

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

  ```json translate=no
  {
    "platform": "YE",
    "discriminator": "marketplace",
    "eatsId": "190330-12345678",
    "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "deliveryInfo": {
      "clientName": "John Cena",
      "phoneNumber": "+79031111111 ext. 4432",
      "additionalPhoneNumbers": [
        null
      ],
      "deliveryDate": "1937-01-01T12:00:27.870000+00:20",
      "deliveryAddress": {
        "full": "Tashkent, Amir Temur Street, building 4, entrance 2. 4th floor, intercom code: 123 K 4567",
        "latitude": "55.756994",
        "longitude": "37.614006"
      }
    },
    "paymentInfo": {
      "paymentType": "CARD",
      "itemsCost": 100,
      "deliveryFee": 100,
      "total": 200,
      "change": 500
    },
    "items": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "name": "Pepperoni Pizza",
        "quantity": 3.5,
        "price": 100,
        "modifications": [
          {
            "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
            "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
            "name": "utensils",
            "quantity": 3,
            "price": 100
          }
        ],
        "promos": [
          {
            "type": "GIFT",
            "discount": 200,
            "partner_discount": 100,
            "yandex_discount": 100
          }
        ]
      }
    ],
    "persons": 2,
    "comment": "Additional order information: ...",
    "promos": [
      null
    ]
  }
  ```

  {% endcut %}

- **Type**: [PickupOrderV1](#entity-PickupOrderV1)

  Current version of the order model for "pickup" delivery scheme

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

  ```json translate=no
  {
    "platform": "YE",
    "discriminator": "pickup",
    "eatsId": "190330-123456",
    "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "deliveryInfo": {
      "clientName": "John Cena",
      "phoneNumber": "+79031111111 ext. 4432",
      "additionalPhoneNumbers": [
        null
      ],
      "clientArrivementDate": "1937-01-01T12:00:27.870000+00:20"
    },
    "paymentInfo": {
      "paymentType": "CARD",
      "itemsCost": 100,
      "total": 200,
      "change": 500
    },
    "items": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "name": "Pepperoni Pizza",
        "quantity": 3.5,
        "price": 100,
        "modifications": [
          {
            "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
            "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
            "name": "utensils",
            "quantity": 3,
            "price": 100
          }
        ],
        "promos": [
          {
            "type": "GIFT",
            "discount": 200,
            "partner_discount": 100,
            "yandex_discount": 100
          }
        ]
      }
    ],
    "persons": 2,
    "comment": "Additional order information: ...",
    "promos": [
      {}
    ]
  }
  ```

  {% endcut %}

{% endcut %}

</div>

<div class="openapi-entity">

### PhoneNumber {#entity-PhoneNumber}

Phone number to contact the customer in international format. Consists of parts "+<country code><number>". May include extension: "+<country code><number> ext. <extension number>".

**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `+79031111111 ext. 4432`

</div>

<div class="openapi-entity">

### YandexOrderDeliveryInfo {#entity-YandexOrderDeliveryInfo}

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

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

The date when the courier arrives at the restaurant, in RFC 3339 format with fractional part of 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}
||
||

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

A list of additional numbers for contacting the client.

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

```json translate=no
[
  "+79031111111 ext. 4432"
]
```

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

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

The customer's name in the Yandex service

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

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

Phone number to contact the customer in international format. Consists of parts "+<country code><number>". May include extension: "+<country code><number> ext. <extension number>".

_Example:_{.json-schema-reset .json-schema-example} `+79031111111 ext. 4432`
{.table-cell}
||
||

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

Courier identification code

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

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

The phone number for contacting the client in an international format. It consists of the parts "+<country code><number>". It is indicated if the client consents to the processing of his personal data

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

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

```json translate=no
{
  "clientName": "John Cena",
  "phoneNumber": "+79031111111 ext. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "courierArrivementDate": "1937-01-01T12:00:27.870000+00:20",
  "realPhoneNumber": "+79031111111",
  "pickupCode": "123"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### YandexOrderPaymentInfo {#entity-YandexOrderPaymentInfo}

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

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

The full cost of the dishes in the order.
{.table-cell}
||
||

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

Information about the payment type. CARD – paid order, CASH – unpaid order.

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

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

```json translate=no
{
  "itemsCost": 100,
  "paymentType": "CARD"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersModificationItem {#entity-OrdersModificationItem}

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

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

ID of the modifier in the partner system

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

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

Price of the modifier for the menu item (e.g., additional sauce)
{.table-cell}
||
||

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

Quantity in the order
{.table-cell}
||
||

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

Unique identifier for a group within a partner system. The Partner Group ID is linked to a specific modifier, which is a component that can be duplicated.

_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

Modifier name

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

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

```json translate=no
{
  "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
  "name": "utensils",
  "quantity": 3,
  "price": 100
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersPromoItem {#entity-OrdersPromoItem}

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

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

Discount amount in currency paid by the partner
{.table-cell}
||
||

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

Promotion type. Can be a gift "GIFT", percentage discount "PERCENTAGE", co-financed discount "COFINANCE" and "FIXED"

_Enum:_{.json-schema-reset .json-schema-value} `GIFT`, `FIXED`, `PERCENTAGE`, `COFINANCE`
{.table-cell}
||
||

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

Part of the discount amount in currency paid by the partner
{.table-cell}
||
||

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

Part of the discount amount in currency paid by Yandex
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "type": "GIFT",
  "discount": 200,
  "partner_discount": 100,
  "yandex_discount": 100
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersItem {#entity-OrdersItem}

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

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

ID of the menu item in the partner system

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

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

List of selected modifications. Can be empty, explicitly transmitted for each individual item in the order. When ordering two items of the same dish with different modifications, different positions with different "modifications" lists are transmitted.

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

```json translate=no
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
    "name": "utensils",
    "quantity": 3,
    "price": 100
  }
]
```

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

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

Price of one item including modification costs.
{.table-cell}
||
||

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

List of promotions applied to the current dish. If the dish has a non-empty "promos" object, it means that a promotion is active in the partner system. If empty, it means no promotions apply to the dish.

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

```json translate=no
[
  {
    "type": "GIFT",
    "discount": 200,
    "partner_discount": 100,
    "yandex_discount": 100
  }
]
```

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

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

Quantity of the item in the order
{.table-cell}
||
||

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

Menu item name

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

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

```json translate=no
{
  "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "name": "Pepperoni Pizza",
  "quantity": 3.5,
  "price": 100,
  "modifications": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
      "name": "utensils",
      "quantity": 3,
      "price": 100
    }
  ],
  "promos": [
    {
      "type": "GIFT",
      "discount": 200,
      "partner_discount": 100,
      "yandex_discount": 100
    }
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### YandexOrderV2 {#entity-YandexOrderV2}

Current version of the order model for "Yandex" delivery scheme.

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

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

Additional order information

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

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

Delivery information.

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

```json translate=no
{
  "clientName": "John Cena",
  "phoneNumber": "+79031111111 ext. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "courierArrivementDate": "1937-01-01T12:00:27.870000+00:20",
  "realPhoneNumber": "+79031111111",
  "pickupCode": "123"
}
```

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

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

Schema discriminator object. For YandexOrder, it is "yandex".

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

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

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

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

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

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

```json translate=no
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "name": "Pepperoni Pizza",
    "quantity": 3.5,
    "price": 100,
    "modifications": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
        "name": "utensils",
        "quantity": 3,
        "price": 100
      }
    ],
    "promos": [
      {
        "type": "GIFT",
        "discount": 200,
        "partner_discount": 100,
        "yandex_discount": 100
      }
    ]
  }
]
```

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

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

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

```json translate=no
{
  "itemsCost": 100,
  "paymentType": "CARD"
}
```

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

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

List of promotions applied to the entire order. If the order has a non-empty "promos" object, it means that a promotion is active in the partner system. If empty, it means no promotions apply to the order.

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

```json translate=no
[
  {
    "type": "GIFT",
    "discount": 200,
    "partner_discount": 100,
    "yandex_discount": 100
  }
]
```

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

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

Internal identifier of the establishment in the partner system to which the order is transmitted. Free format, UUID4 recommended.

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

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

Number of persons for whom the order is placed. May affect the number of cutlery sets.
{.table-cell}
||
||

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

Platform ID:
* YE – Yandex


_Const:_{.json-schema-reset .json-schema-value} `YE`

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

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

```json translate=no
{
  "platform": "YE",
  "discriminator": "yandex",
  "eatsId": "190330-12345678",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "John Cena",
    "phoneNumber": "+79031111111 ext. 4432",
    "additionalPhoneNumbers": [
      null
    ],
    "courierArrivementDate": "1937-01-01T12:00:27.870000+00:20",
    "realPhoneNumber": "+79031111111",
    "pickupCode": "123"
  },
  "paymentInfo": {
    "itemsCost": 100,
    "paymentType": "CARD"
  },
  "items": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "name": "Pepperoni Pizza",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "utensils",
          "quantity": 3,
          "price": 100
        }
      ],
      "promos": [
        {
          "type": "GIFT",
          "discount": 200,
          "partner_discount": 100,
          "yandex_discount": 100
        }
      ]
    }
  ],
  "persons": 2,
  "comment": "Additional order information: ...",
  "promos": [
    {}
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DeliveryAddress {#entity-DeliveryAddress}

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

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

Full address

_Example:_{.json-schema-reset .json-schema-example} `Tashkent, Amir Temur Street, building 4, entrance 2. 4th floor, intercom code: 123 K 4567`
{.table-cell}
||
||

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

Delivery point latitude

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

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

Delivery point longitude

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

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

```json translate=no
{
  "full": "Tashkent, Amir Temur Street, building 4, entrance 2. 4th floor, intercom code: 123 K 4567",
  "latitude": "55.756994",
  "longitude": "37.614006"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### MarketplaceOrderDeliveryInfo {#entity-MarketplaceOrderDeliveryInfo}

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

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

Client's name in Yandex service

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

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

Delivery address information

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

```json translate=no
{
  "full": "Tashkent, Amir Temur Street, building 4, entrance 2. 4th floor, intercom code: 123 K 4567",
  "latitude": "55.756994",
  "longitude": "37.614006"
}
```

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

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

Delivery date (when the client expects the order), 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}
||
||

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

Phone number to contact the customer in international format. Consists of parts "+<country code><number>". May include extension: "+<country code><number> ext. <extension number>".

_Example:_{.json-schema-reset .json-schema-example} `+79031111111 ext. 4432`
{.table-cell}
||
||

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

A list of additional numbers for contacting the client.

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

```json translate=no
[
  "+79031111111 ext. 4432"
]
```

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

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

```json translate=no
{
  "clientName": "John Cena",
  "phoneNumber": "+79031111111 ext. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "deliveryDate": "1937-01-01T12:00:27.870000+00:20",
  "deliveryAddress": {
    "full": "Tashkent, Amir Temur Street, building 4, entrance 2. 4th floor, intercom code: 123 K 4567",
    "latitude": "55.756994",
    "longitude": "37.614006"
  }
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### MarketplaceOrderPaymentInfo {#entity-MarketplaceOrderPaymentInfo}

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

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

Amount of change required
{.table-cell}
||
||

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

Delivery cost
{.table-cell}
||
||

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

Total cost of the dishes in the order
{.table-cell}
||
||

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

Payment type information. CARD – already paid order, CASH – unpaid order.

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

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

Total order cost
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "paymentType": "CARD",
  "itemsCost": 100,
  "deliveryFee": 100,
  "total": 200,
  "change": 500
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### MarketplaceOrderV2 {#entity-MarketplaceOrderV2}

Current version of the order model for "Marketplace" delivery scheme

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

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

Additional order information

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

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

Delivery information

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

```json translate=no
{
  "clientName": "John Cena",
  "phoneNumber": "+79031111111 ext. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "deliveryDate": "1937-01-01T12:00:27.870000+00:20",
  "deliveryAddress": {
    "full": "Tashkent, Amir Temur Street, building 4, entrance 2. 4th floor, intercom code: 123 K 4567",
    "latitude": "55.756994",
    "longitude": "37.614006"
  }
}
```

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

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

Schema discriminator object. For MarketplaceOrder, it is "marketplace"

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

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

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

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

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

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

```json translate=no
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "name": "Pepperoni Pizza",
    "quantity": 3.5,
    "price": 100,
    "modifications": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
        "name": "utensils",
        "quantity": 3,
        "price": 100
      }
    ],
    "promos": [
      {
        "type": "GIFT",
        "discount": 200,
        "partner_discount": 100,
        "yandex_discount": 100
      }
    ]
  }
]
```

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

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

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

```json translate=no
{
  "paymentType": "CARD",
  "itemsCost": 100,
  "deliveryFee": 100,
  "total": 200,
  "change": 500
}
```

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

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

List of promotions applied to the entire order. If the order has a non-empty "promos" object, it means that a promotion is active in the partner system. If empty, it means no promotions apply to the order.

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

```json translate=no
[
  {
    "type": "GIFT",
    "discount": 200,
    "partner_discount": 100,
    "yandex_discount": 100
  }
]
```

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

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

Internal identifier of the establishment in the partner system to which the order is transmitted. Free format, UUID4 recommended

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

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

Number of persons for whom the order is placed. May affect the number of cutlery sets
{.table-cell}
||
||

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

Platform identifier. YE - Yandex

_Const:_{.json-schema-reset .json-schema-value} `YE`

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

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

```json translate=no
{
  "platform": "YE",
  "discriminator": "marketplace",
  "eatsId": "190330-12345678",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "John Cena",
    "phoneNumber": "+79031111111 ext. 4432",
    "additionalPhoneNumbers": [
      null
    ],
    "deliveryDate": "1937-01-01T12:00:27.870000+00:20",
    "deliveryAddress": {
      "full": "Tashkent, Amir Temur Street, building 4, entrance 2. 4th floor, intercom code: 123 K 4567",
      "latitude": "55.756994",
      "longitude": "37.614006"
    }
  },
  "paymentInfo": {
    "paymentType": "CARD",
    "itemsCost": 100,
    "deliveryFee": 100,
    "total": 200,
    "change": 500
  },
  "items": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "name": "Pepperoni Pizza",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "utensils",
          "quantity": 3,
          "price": 100
        }
      ],
      "promos": [
        {
          "type": "GIFT",
          "discount": 200,
          "partner_discount": 100,
          "yandex_discount": 100
        }
      ]
    }
  ],
  "persons": 2,
  "comment": "Additional order information: ...",
  "promos": [
    null
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PickupOrderDeliveryInfo {#entity-PickupOrderDeliveryInfo}

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

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

The date when the customer arrives at the restaurant, in RFC 3339 format with fractional part of 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}
||
||

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

Client's name in Yandex service

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

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

Phone number to contact the customer in international format. Consists of parts "+<country code><number>". May include extension: "+<country code><number> ext. <extension number>".

_Example:_{.json-schema-reset .json-schema-example} `+79031111111 ext. 4432`
{.table-cell}
||
||

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

A list of additional numbers for contacting the client.

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

```json translate=no
[
  "+79031111111 ext. 4432"
]
```

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

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

```json translate=no
{
  "clientName": "John Cena",
  "phoneNumber": "+79031111111 ext. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "clientArrivementDate": "1937-01-01T12:00:27.870000+00:20"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PickupOrderPaymentInfo {#entity-PickupOrderPaymentInfo}

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

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

Amount of change required.
{.table-cell}
||
||

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

Total cost of the dishes in the order
{.table-cell}
||
||

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

Payment type information

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

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

Total order cost
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "paymentType": "CARD",
  "itemsCost": 100,
  "total": 200,
  "change": 500
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PickupOrderV1 {#entity-PickupOrderV1}

Current version of the order model for "pickup" delivery scheme

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

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

Additional order information

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

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

Delivery info

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

```json translate=no
{
  "clientName": "John Cena",
  "phoneNumber": "+79031111111 ext. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "clientArrivementDate": "1937-01-01T12:00:27.870000+00:20"
}
```

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

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

Object schema discriminator. For PickupOrder equals "pickup"

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

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

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

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

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

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

```json translate=no
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "name": "Pepperoni Pizza",
    "quantity": 3.5,
    "price": 100,
    "modifications": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
        "name": "utensils",
        "quantity": 3,
        "price": 100
      }
    ],
    "promos": [
      {
        "type": "GIFT",
        "discount": 200,
        "partner_discount": 100,
        "yandex_discount": 100
      }
    ]
  }
]
```

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

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

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

```json translate=no
{
  "paymentType": "CARD",
  "itemsCost": 100,
  "total": 200,
  "change": 500
}
```

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

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

List of promotions active for the entire order. If the order object "promos" is not empty, then the order has a promotion in the partner's system. If empty – this means that the order does not have any promotions

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

```json translate=no
[
  {
    "type": "GIFT",
    "discount": 200,
    "partner_discount": 100,
    "yandex_discount": 100
  }
]
```

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

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

Internal identifier of the establishment in the partner system to which the order is transmitted. Free format, UUID4 recommended

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

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

Number of people the order is for. May affect the number of utensil sets
{.table-cell}
||
||

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

Platform identifier. YE - Yandex

_Const:_{.json-schema-reset .json-schema-value} `YE`

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

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

```json translate=no
{
  "platform": "YE",
  "discriminator": "pickup",
  "eatsId": "190330-123456",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "John Cena",
    "phoneNumber": "+79031111111 ext. 4432",
    "additionalPhoneNumbers": [
      null
    ],
    "clientArrivementDate": "1937-01-01T12:00:27.870000+00:20"
  },
  "paymentInfo": {
    "paymentType": "CARD",
    "itemsCost": 100,
    "total": 200,
    "change": 500
  },
  "items": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "name": "Pepperoni Pizza",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "utensils",
          "quantity": 3,
          "price": 100
        }
      ],
      "promos": [
        {
          "type": "GIFT",
          "discount": 200,
          "partner_discount": 100,
          "yandex_discount": 100
        }
      ]
    }
  ],
  "persons": 2,
  "comment": "Additional order information: ...",
  "promos": [
    {}
  ]
}
```

{% endcut %}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

The order has been successfully processed by the restaurant's internal system

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "result": "OK",
  "orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63"
}
```

{% endcut %}

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

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

The identifier of the created order in the partner's system. The format is freeform. UUID4 is recommended.

_Example:_{.json-schema-reset .json-schema-example} `03d3b69b-331c-4f84-b2c4-888b30320e63`
{.table-cell}
||
||

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

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

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Bad request. **_An array with an object from the error list is expected in the response body_**

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
[
  {
    "code": 100,
    "description": "Description of error"
  }
]
```

{% endcut %}

**Type**: [ErrorItem](#entity-ErrorItem)[]

</div>

<div class="openapi-entity">

### ErrorItem {#entity-ErrorItem}

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

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

Error code agreed with Yandex
{.table-cell}
||
||

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

Error message

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

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

```json translate=no
{
  "code": 100,
  "description": "Description of error"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__401">

## 401 Unauthorized

Authorization failed - the token expired or was not passed in the request. A retry will be made

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "reason": "Access token has been expired. You should request a new one"
}
```

{% endcut %}

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

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

Reason for authorization failure

_Example:_{.json-schema-reset .json-schema-example} `Access token has been expired. You should request a new one`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__406">

## 406 Not Acceptable

Some items in the order are on the partner's stop list

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "type": "unavailable_goods",
  "message": "At the moment, the product is not available for order: pie with cream cheese and avocado",
  "goods": "{\"10000000003998\": \"pie with cream cheese and avocado\"}"
}
```

{% endcut %}

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

_goods_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
|#{.json-schema-properties}

{% endcut %}

_Example:_{.json-schema-reset .json-schema-example} `{"10000000003998": "pie with cream cheese and avocado"}`
{.table-cell}
||
||

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

_Example:_{.json-schema-reset .json-schema-example} `At the moment, the product is not available for order: pie with cream cheese and avocado`
{.table-cell}
||
||

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

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

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

Internal server errors. **_An array with an object from the error list is expected in the response body_**

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
[
  {
    "code": 100,
    "description": "Description of error"
  }
]
```

{% endcut %}

**Type**: [ErrorItem](#entity-ErrorItem)[]

</div>

</div>

</div>

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