Обновить заказ в системе ресторана

Обновление состава заказа в системе партнера по инициативе Яндекс Еды. Для использования данного метода требуется согласование с сотрудниками Яндекса. Передается объект заказа целиком. Актуальная версия модели запроса - application/vnd.eats.order.v2+json

Request

PUT

/order/{orderId}

Path parameters

Name

Description

orderId

Type: string

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

Example: ``

Body

application/vnd.eats.order.v2+json
{
  "platform": "YE",
  "discriminator": "marketplace",
  "eatsId": "190330-12345678",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "phoneNumber": "+79031111111 доб. 4432",
    "additionalPhoneNumbers": [
      null
    ],
    "deliveryDate": "1937-01-01T12:00:27.870000+00:20",
    "deliveryAddress": {
      "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 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": "Пицца Пепперони",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {}
      ],
      "promos": [
        {}
      ],
      "comboInfo": {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
      }
    }
  ],
  "persons": 2,
  "comment": "Дополнительная информация о заказе: ...",
  "promos": [
    null
  ]
}
One of 3 types

  • Type: MarketplaceOrderV2

    Актуальная версия модели заказа по схеме доставки "marketplace"

    Example
    {
  "platform": "YE",
  "discriminator": "marketplace",
  "eatsId": "190330-12345678",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "phoneNumber": "+79031111111 доб. 4432",
    "additionalPhoneNumbers": [
      null
    ],
    "deliveryDate": "1937-01-01T12:00:27.870000+00:20",
    "deliveryAddress": {
      "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 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": "Пицца Пепперони",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "Европейские приборы",
          "quantity": 3,
          "price": 100
        }
      ],
      "promos": [
        {
          "type": "GIFT",
          "discount": 200,
          "partner_discount": 100,
          "yandex_discount": 100
        }
      ],
      "comboInfo": {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
      }
    }
  ],
  "persons": 2,
  "comment": "Дополнительная информация о заказе: ...",
  "promos": [
    null
  ]
}

  • Type: YandexOrderV2

    Актуальная версия модели заказа по схеме доставки "yandex".

    Example
    {
  "platform": "YE",
  "discriminator": "yandex",
  "eatsId": "190330-12345678",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "phoneNumber": "+79031111111 доб. 4432",
    "additionalPhoneNumbers": [
      null
    ],
    "courierArrivementDate": "1937-01-01T12:00:27.870000+00:20",
    "realPhoneNumber": "79031111111",
    "pickupCode": "123",
    "batches": [
      "240425-1548210",
      "240425-1548211"
    ]
  },
  "paymentInfo": {
    "itemsCost": 100,
    "paymentType": "CARD"
  },
  "items": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "name": "Пицца Пепперони",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "Европейские приборы",
          "quantity": 3,
          "price": 100
        }
      ],
      "promos": [
        {
          "type": "GIFT",
          "discount": 200,
          "partner_discount": 100,
          "yandex_discount": 100
        }
      ],
      "comboInfo": {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
      }
    }
  ],
  "persons": 2,
  "comment": "Дополнительная информация о заказе: ...",
  "promos": [
    {}
  ]
}

  • Type: PickupOrderV1

    Актуальная версия модели заказа по схеме доставки "pickup"

    Example
    {
  "platform": "YE",
  "discriminator": "pickup",
  "eatsId": "190330-123456",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "phoneNumber": "+79031111111 доб. 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": "Пицца Пепперони",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "Европейские приборы",
          "quantity": 3,
          "price": 100
        }
      ],
      "promos": [
        {
          "type": "GIFT",
          "discount": 200,
          "partner_discount": 100,
          "yandex_discount": 100
        }
      ],
      "comboInfo": {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
      }
    }
  ],
  "persons": 2,
  "comment": "Дополнительная информация о заказе: ...",
  "promos": [
    {}
  ]
}

PhoneNumber

Номер телефона для связи с клиентом в международном формате. Состоит из частей "+<код страны><номер>". Может содержать добавочный номер: "+<код страны><номер> доб. <добавочный номер>".

Type: string

Example: +79031111111 доб. 4432

DeliveryAddress

Name

Description

full

Type: string

Полный адрес

Example: Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567

latitude

Type: string

Широта точки доставки

Example: 55.756994

longitude

Type: string

Долгота точки доставки

Example: 37.614006
Example
{
  "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
  "latitude": "55.756994",
  "longitude": "37.614006"
}

MarketplaceOrderDeliveryInfo

Name

Description

clientName

Type: string

Имя клиента в сервисе Яндекс Еда

Example: Иванов Иван Иванович

deliveryAddress

Type: DeliveryAddress

Информация об адресе доставки

Example
{
  "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
  "latitude": "55.756994",
  "longitude": "37.614006"
}

deliveryDate

Type: string<date-time>

Дата доставки (к которой клиент ожидает доставку заказа), в формате RFC3339 с дробной частью секунд (Y-m-d\TH:i:s.uP)

Example: 1937-01-01T12:00:27.870000+00:20

phoneNumber

Type: PhoneNumber

Номер телефона для связи с клиентом в международном формате. Состоит из частей "+<код страны><номер>". Может содержать добавочный номер: "+<код страны><номер> доб. <добавочный номер>".

Example: +79031111111 доб. 4432

additionalPhoneNumbers

Type: PhoneNumber[]

Список дополнительных номеров для связи с клиентом.

Example
[
  "+79031111111 доб. 4432"
]
Example
{
  "clientName": "Иванов Иван Иванович",
  "phoneNumber": "+79031111111 доб. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "deliveryDate": "1937-01-01T12:00:27.870000+00:20",
  "deliveryAddress": {
    "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
    "latitude": "55.756994",
    "longitude": "37.614006"
  }
}

MarketplaceOrderPaymentInfo

Name

Description

change

Type: number

Сумма, с которой потребуется сдача.

deliveryFee

Type: number

Стоимость доставки

itemsCost

Type: number

Полная стоимость блюд в заказе, обычна равна сумме стоимости блюд, которые передает партнер в меню. Если в заказе есть скидка на корзину, то она учитывается и вычитается в этом поле.

paymentType

Type: string

Информация о типе оплаты. CARD – уже оплаченный заказа, CASH – неоплаченный заказ.

Enum: CARD, CASH

total

Type: number

Общая стоимость заказа. То есть itemsCost + deliveryFee
Example
{
  "paymentType": "CARD",
  "itemsCost": 100,
  "deliveryFee": 100,
  "total": 200,
  "change": 500
}

OrdersModificationItem

Name

Description

id

Type: string

ID модификатора в системе партнера

Example: 937c57f6-4508-4858-be7f-20691a16fbb0

price

Type: number

Цена модификатора для пункта меню (например - дополнительный соус)

quantity

Type: integer

Количество в заказе

group_id

Type: string

ID группы в системе партнера, к которой принадлежит модификатор. Используется для однозначной идентификации модификатора при его дублировании.

Example: 937c57f6-4508-4858-be7f-20691a16fbb1

name

Type: string

Наименование модификатора

Example: Европейские приборы
Example
{
  "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
  "name": "Европейские приборы",
  "quantity": 3,
  "price": 100
}

OrdersPromoItem

Name

Description

discount

Type: number

Сумма скидки в валюте, оплачиваемая партнёром

type

Type: string

Тип акции. Может быть подарок "GIFT", процентная скидка "PERCENTAGE", софинансируемая скидка "COFINANCE", фиксированная скидка "FIXED"

Enum: GIFT, PERCENTAGE, COFINANCE, FIXED

partner_discount

Type: number

Часть суммы скидки в валюте, оплачиваемая партнером

yandex_discount

Type: number

Часть суммы скидки в валюте, оплачиваемая Яндекс.Едой
Example
{
  "type": "GIFT",
  "discount": 200,
  "partner_discount": 100,
  "yandex_discount": 100
}

OrderItemComboInfo

Информация о комбо, к которому относится данная позиция. Заполнено только для позиций, которые были выбраны в составе комбо.

Name

Description

componentId

Type: string

ID компонента комбо, к которому относится данная позиция.

Example: 937c57f6-4508-4858-be7f-20691a16fbb0

id

Type: string

ID комбо из меню, к которому относится данная позиция.

Example: 937c57f6-4508-4858-be7f-20691a16fbb0
Example
{
  "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
}

OrdersItem

Name

Description

id

Type: string

ID позиции меню в системе партнера

Example: 937c57f6-4508-4858-be7f-20691a16fbb0

modifications

Type: OrdersModificationItem[]

Список выбранных модификаций. Может быть пустым, передаётся явно, для каждой отдельной позиции в заказе. При заказе двух позиций одного и того же блюда с разным набором модификаций - передаются разные позиции, с разными списками "modifications"

Example
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
    "name": "Европейские приборы",
    "quantity": 3,
    "price": 100
  }
]

price

Type: number

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

promos

Type: OrdersPromoItem[]

Список акций, действующих на текущее блюдо. Если у блюда объект "promos" не пустой, значит на него действует акция в системе партнера. Если пустой – это означает, что на блюдо не действуют никакие акции

Example
[
  {
    "type": "GIFT",
    "discount": 200,
    "partner_discount": 100,
    "yandex_discount": 100
  }
]

quantity

Type: number

Количество позиции в заказе

comboInfo

Type: OrderItemComboInfo

Информация о комбо, к которому относится данная позиция. Заполнено только для позиций, которые были выбраны в составе комбо.

Example
{
  "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
}

name

Type: string

Наименование позиции меню

Example: Пицца Пепперони
Example
{
  "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "name": "Пицца Пепперони",
  "quantity": 3.5,
  "price": 100,
  "modifications": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
      "name": "Европейские приборы",
      "quantity": 3,
      "price": 100
    }
  ],
  "promos": [
    {
      "type": "GIFT",
      "discount": 200,
      "partner_discount": 100,
      "yandex_discount": 100
    }
  ],
  "comboInfo": {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
  }
}

MarketplaceOrderV2

Актуальная версия модели заказа по схеме доставки "marketplace"

Name

Description

comment

Type: string

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

Example: Дополнительная информация о заказе: ...

deliveryInfo

Type: MarketplaceOrderDeliveryInfo

Информация о доставке

Example
{
  "clientName": "Иванов Иван Иванович",
  "phoneNumber": "+79031111111 доб. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "deliveryDate": "1937-01-01T12:00:27.870000+00:20",
  "deliveryAddress": {
    "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
    "latitude": "55.756994",
    "longitude": "37.614006"
  }
}

discriminator

Type: string

Дискриминатор схемы обьекта. Для MarketplaceOrder равен "marketplace"

Example: marketplace

eatsId

Type: string

Сквозной идентификатор заказа на стороне Яндекс.Еды в формате DDDDDD-DDDDDDDD

Example: 190330-12345678

items

Type: OrdersItem[]

Example
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "name": "Пицца Пепперони",
    "quantity": 3.5,
    "price": 100,
    "modifications": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
        "name": "Европейские приборы",
        "quantity": 3,
        "price": 100
      }
    ],
    "promos": [
      {
        "type": "GIFT",
        "discount": 200,
        "partner_discount": 100,
        "yandex_discount": 100
      }
    ],
    "comboInfo": {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
    }
  }
]

paymentInfo

Type: MarketplaceOrderPaymentInfo

Example
{
  "paymentType": "CARD",
  "itemsCost": 100,
  "deliveryFee": 100,
  "total": 200,
  "change": 500
}

promos

Type: OrdersPromoItem[]

Список акций, действующих на весь заказ. Если у заказа объект "promos" не пустой, значит на него действует акция в системе партнера. Если пустой – это означает, что на заказ не действуют никакие акции

Example
[
  {
    "type": "GIFT",
    "discount": 200,
    "partner_discount": 100,
    "yandex_discount": 100
  }
]

restaurantId

Type: string

Внутренний идентификатор заведения в системе партнера, в которое передаётся заказ. Формат свободный, рекомендуется UUID4

Example: 937c57f6-4508-4858-be7f-20691a16fbb0

persons

Type: integer

Количество персон, на которых оформлен заказ. Может влиять на количество комплектов приборов

platform

Type: string

Идентификатор платформы. YE - Yandex Eda, DC - Delivery club

Enum: YE, DC
Example
{
  "platform": "YE",
  "discriminator": "marketplace",
  "eatsId": "190330-12345678",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "phoneNumber": "+79031111111 доб. 4432",
    "additionalPhoneNumbers": [
      null
    ],
    "deliveryDate": "1937-01-01T12:00:27.870000+00:20",
    "deliveryAddress": {
      "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 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": "Пицца Пепперони",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "Европейские приборы",
          "quantity": 3,
          "price": 100
        }
      ],
      "promos": [
        {
          "type": "GIFT",
          "discount": 200,
          "partner_discount": 100,
          "yandex_discount": 100
        }
      ],
      "comboInfo": {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
      }
    }
  ],
  "persons": 2,
  "comment": "Дополнительная информация о заказе: ...",
  "promos": [
    null
  ]
}

YandexOrderDeliveryInfo

Name

Description

courierArrivementDate

Type: string<date-time>

Дата, когда придет курьер в ресторан, в формате RFC3339 с дробной частью секунд (Y-m-d\TH:i:s.uP).

Example: 1937-01-01T12:00:27.870000+00:20

additionalPhoneNumbers

Type: PhoneNumber[]

Список дополнительных номеров для связи с клиентом.

Example
[
  "+79031111111 доб. 4432"
]

batches

Type: string[]

Список идентификаторов заказов в системе Яндекс.Еды, входящих в один батч вместе с текущим заказом. Если заказ не входит в батч — передаётся пустой массив. Если информация о батчах пока недоступна — поле отсутствует.

Example
[
  "240425-1548210",
  "240425-1548211"
]

clientName

Type: string

Имя клиента в сервисе Яндекс Еда

Example: Иванов Иван Иванович

phoneNumber

Type: PhoneNumber

Номер телефона для связи с клиентом в международном формате. Состоит из частей "+<код страны><номер>". Может содержать добавочный номер: "+<код страны><номер> доб. <добавочный номер>".

Example: +79031111111 доб. 4432

pickupCode

Type: string

Код для идентификации курьера

Example: 123

realPhoneNumber

Type: string

Номер телефона для связи с клиентом в международном формате. Состоит из частей "+<код страны><номер>". Указывается в случае если клиент дает согласие на обработку своих персональных данных

Example: 79031111111
Example
{
  "clientName": "Иванов Иван Иванович",
  "phoneNumber": "+79031111111 доб. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "courierArrivementDate": "1937-01-01T12:00:27.870000+00:20",
  "realPhoneNumber": "79031111111",
  "pickupCode": "123",
  "batches": [
    "240425-1548210",
    "240425-1548211"
  ]
}

YandexOrderPaymentInfo

Name

Description

itemsCost

Type: number

Полная стоимость блюд в заказе, обычна равна сумме стоимости блюд, которые передает партнер в меню. Если в заказе есть скидка на корзину, то она учитывается и вычитается в этом поле.

paymentType

Type: string

Информация о типе оплаты. CARD – оплаченный заказа, CASH – неоплаченный заказ.

Enum: CARD, CASH
Example
{
  "itemsCost": 100,
  "paymentType": "CARD"
}

YandexOrderV2

Актуальная версия модели заказа по схеме доставки "yandex".

Name

Description

comment

Type: string

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

Example: Дополнительная информация о заказе: ...

deliveryInfo

Type: YandexOrderDeliveryInfo

Информация о доставке.

Example
{
  "clientName": "Иванов Иван Иванович",
  "phoneNumber": "+79031111111 доб. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "courierArrivementDate": "1937-01-01T12:00:27.870000+00:20",
  "realPhoneNumber": "79031111111",
  "pickupCode": "123",
  "batches": [
    "240425-1548210",
    "240425-1548211"
  ]
}

discriminator

Type: string

Дискриминатор схемы обьекта. Для YandexOrder равен "yandex".

Example: yandex

eatsId

Type: string

Сквозной идентификатор заказа на стороне Яндекс.Еды в формате DDDDDD-DDDDDDDD.

Example: 190330-12345678

items

Type: OrdersItem[]

Example
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "name": "Пицца Пепперони",
    "quantity": 3.5,
    "price": 100,
    "modifications": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
        "name": "Европейские приборы",
        "quantity": 3,
        "price": 100
      }
    ],
    "promos": [
      {
        "type": "GIFT",
        "discount": 200,
        "partner_discount": 100,
        "yandex_discount": 100
      }
    ],
    "comboInfo": {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
    }
  }
]

paymentInfo

Type: YandexOrderPaymentInfo

Example
{
  "itemsCost": 100,
  "paymentType": "CARD"
}

promos

Type: OrdersPromoItem[]

Список акций, действующих на весь заказ. Если у заказа объект "promos" не пустой, значит на него действует акция в системе партнера. Если пустой – это означает, что на заказ не действуют никакие акции

Example
[
  {
    "type": "GIFT",
    "discount": 200,
    "partner_discount": 100,
    "yandex_discount": 100
  }
]

restaurantId

Type: string

Внутренний идентификатор заведения в системе партнера, в которое передаётся заказ. Формат свободный, рекомендуется UUID4.

Example: 937c57f6-4508-4858-be7f-20691a16fbb0

persons

Type: integer

Количество персон, на которых оформлен заказ. Может влиять на количество комплектов приборов

platform

Type: string

Идентификатор платформы:

  • YE – Yandex Eda.
  • DC – Delivery club.

Enum: YE, DC
Example
{
  "platform": "YE",
  "discriminator": "yandex",
  "eatsId": "190330-12345678",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "phoneNumber": "+79031111111 доб. 4432",
    "additionalPhoneNumbers": [
      null
    ],
    "courierArrivementDate": "1937-01-01T12:00:27.870000+00:20",
    "realPhoneNumber": "79031111111",
    "pickupCode": "123",
    "batches": [
      "240425-1548210",
      "240425-1548211"
    ]
  },
  "paymentInfo": {
    "itemsCost": 100,
    "paymentType": "CARD"
  },
  "items": [
    {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "name": "Пицца Пепперони",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "Европейские приборы",
          "quantity": 3,
          "price": 100
        }
      ],
      "promos": [
        {
          "type": "GIFT",
          "discount": 200,
          "partner_discount": 100,
          "yandex_discount": 100
        }
      ],
      "comboInfo": {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
      }
    }
  ],
  "persons": 2,
  "comment": "Дополнительная информация о заказе: ...",
  "promos": [
    {}
  ]
}

PickupOrderDeliveryInfo

Name

Description

clientArrivementDate

Type: string<date-time>

Дата, когда придет клиент в ресторан, в формате RFC3339 с дробной частью секунд (Y-m-d\TH:i:s.uP)

Example: 1937-01-01T12:00:27.870000+00:20

clientName

Type: string

Имя клиента в сервисе Яндекс Еда

Example: Иванов Иван Иванович

phoneNumber

Type: PhoneNumber

Номер телефона для связи с клиентом в международном формате. Состоит из частей "+<код страны><номер>". Может содержать добавочный номер: "+<код страны><номер> доб. <добавочный номер>".

Example: +79031111111 доб. 4432

additionalPhoneNumbers

Type: PhoneNumber[]

Список дополнительных номеров для связи с клиентом.

Example
[
  "+79031111111 доб. 4432"
]
Example
{
  "clientName": "Иванов Иван Иванович",
  "phoneNumber": "+79031111111 доб. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "clientArrivementDate": "1937-01-01T12:00:27.870000+00:20"
}

PickupOrderPaymentInfo

Name

Description

change

Type: number

Сумма, с которой потребуется сдача.

itemsCost

Type: number

Полная стоимость блюд в заказе, обычна равна сумме стоимости блюд, которые передает партнер в меню. Если в заказе есть скидка на корзину, то она учитывается и вычитается в этом поле.

paymentType

Type: string

Информация о типе оплаты

Enum: CARD, CASH

total

Type: number

Общая стоимость заказа
Example
{
  "paymentType": "CARD",
  "itemsCost": 100,
  "total": 200,
  "change": 500
}

PickupOrderV1

Актуальная версия модели заказа по схеме доставки "pickup"

Name

Description

comment

Type: string

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

Example: Дополнительная информация о заказе: ...

deliveryInfo

Type: PickupOrderDeliveryInfo

Информация о доставке

Example
{
  "clientName": "Иванов Иван Иванович",
  "phoneNumber": "+79031111111 доб. 4432",
  "additionalPhoneNumbers": [
    null
  ],
  "clientArrivementDate": "1937-01-01T12:00:27.870000+00:20"
}

discriminator

Type: string

Дискриминатор схемы обьекта. Для PickupOrder равен "pickup"

Example: pickup

eatsId

Type: string

Сквозной идентификатор заказа на стороне Яндекс Еды в формате DDDDDD-DDDDDD

Example: 190330-123456

items

Type: OrdersItem[]

Example
[
  {
    "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
    "name": "Пицца Пепперони",
    "quantity": 3.5,
    "price": 100,
    "modifications": [
      {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
        "name": "Европейские приборы",
        "quantity": 3,
        "price": 100
      }
    ],
    "promos": [
      {
        "type": "GIFT",
        "discount": 200,
        "partner_discount": 100,
        "yandex_discount": 100
      }
    ],
    "comboInfo": {
      "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
      "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
    }
  }
]

paymentInfo

Type: PickupOrderPaymentInfo

Example
{
  "paymentType": "CARD",
  "itemsCost": 100,
  "total": 200,
  "change": 500
}

promos

Type: OrdersPromoItem[]

Список акций, действующих на весь заказ. Если у заказа объект "promos" не пустой, значит на него действует акция в системе партнера. Если пустой – это означает, что на заказ не действуют никакие акции

Example
[
  {
    "type": "GIFT",
    "discount": 200,
    "partner_discount": 100,
    "yandex_discount": 100
  }
]

restaurantId

Type: string

Внутренний идентификатор заведения в системе партнера, в которое передаётся заказ. Формат свободный, рекомендуется UUID4

Example: 937c57f6-4508-4858-be7f-20691a16fbb0

persons

Type: integer

Количество персон, на которых оформлен заказ. Может влиять на количество комплектов приборов

platform

Type: string

Идентификатор платформы. YE - Yandex Eda, DC - Delivery club

Enum: YE, DC
Example
{
  "platform": "YE",
  "discriminator": "pickup",
  "eatsId": "190330-123456",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "phoneNumber": "+79031111111 доб. 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": "Пицца Пепперони",
      "quantity": 3.5,
      "price": 100,
      "modifications": [
        {
          "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
          "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
          "name": "Европейские приборы",
          "quantity": 3,
          "price": 100
        }
      ],
      "promos": [
        {
          "type": "GIFT",
          "discount": 200,
          "partner_discount": 100,
          "yandex_discount": 100
        }
      ],
      "comboInfo": {
        "id": "937c57f6-4508-4858-be7f-20691a16fbb0",
        "componentId": "937c57f6-4508-4858-be7f-20691a16fbb0"
      }
    }
  ],
  "persons": 2,
  "comment": "Дополнительная информация о заказе: ...",
  "promos": [
    {}
  ]
}

Responses

200 OK

Обновление заказа успешно обработано внутренней системой ресторана

Body

application/json
{
  "result": "OK"
}

Name

Description

result

Type: string

Example: OK

400 Bad Request

Bad request. Ошибка в параметрах. В теле ответа ожидается массив с объектом из списка ошибок

Body

application/json
[
  {
    "code": 100,
    "description": "Description of error"
  }
]

Type: ErrorItem[]

ErrorItem

Name

Description

code

Type: integer

Согласованный с Яндекс.Еда числовой код ошибки

description

Type: string

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

Example: Description of error
Example
{
  "code": 100,
  "description": "Description of error"
}

401 Unauthorized

Не пройдена авторизация - истек токен, либо не был передан в запросе. Будет сделан ретрай.

Body

application/json
{
  "reason": "Access token has been expired. You should request a new one"
}

Name

Description

reason

Type: string

Причина, по которой не прошла авторизация

Example: Access token has been expired. You should request a new one

404 Not Found

Заказ не найден в системе. В теле ответа ожидается массив с объектом из списка ошибок

Body

application/json
[
  {
    "code": 100,
    "description": "Description of error"
  }
]

Type: ErrorItem[]

422 Unprocessable Entity

Заказ не может быть обновлен

Body

application/json
[
  {
    "code": 100,
    "description": "Description of error"
  }
]

Type: ErrorItem[]

500 Internal Server Error

Внутренние ошибки сервера. В теле ответа ожидается массив с объектом из списка ошибок

Body

application/json
[
  {
    "code": 100,
    "description": "Description of error"
  }
]

Type: ErrorItem[]

Предыдущая
Получить информацию о заказе в системе ресторана
Следующая
Отменить заказ в системе ресторана