❗️Создание заказа

Метод позволяет Яндекс Еде создать заказ в системе Партнёра.

Если в теле запроса указан товар, которого нет в наличии, ожидается, что метод вернёт успешный HTTP‑ответ (200 OK).
При этом в последующем вызове метода получения информации о заказе данный товар должен быть исключён либо заменён на доступный аналог

  • YandexOrder – схема заказа при доставке курьерами-партнерами сервиса Яндекс Еды.
  • MarketplaceOrder – схема заказа при доставке курьерами Партнера.
  • PickupOrder – схема заказа при самовывозе.

Актуальная версия модели запроса – application/vnd.eats.order.v2+json.

Примечание

Заголовок Content-type в запросе и ответе отличаются.

Request

POST

/order

Headers

Name

Description

Authorization

Type: string

Токен, полученный в ответе на запрос /security/oauth/token

Example: ``

Body

application/vnd.eats.order.v2+json
{
  "promos": [
    {
      "type": "PERCENTAGE",
      "discount": 100
    }
  ],
  "brand": "example",
  "comment": "Код курьера: 4563. Дополнительная информация о заказе...",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "isSlotDelivery": true,
    "phoneNumber": "+74732006745 доб. 12099",
    "realPhoneNumber": "79998887766",
    "deliveryAddress": {
      "city": "Москва",
      "entrance": "6",
      "flat": "234",
      "floor": "12",
      "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
      "house": "4к1",
      "intercom": "234",
      "latitude": "55.756994",
      "longitude": "37.614006",
      "region": "Видное",
      "street": "улица Викторенко"
    }
  },
  "discriminator": "yandex",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "Молоко Домик в деревне",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD"
  },
  "platform": "YE",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0"
}
One of 3 types

  • Type: YandexOrderCreate

    Информация о заказе с доставкой курьерами-партнерами сервиса Яндекс Еды — "yandex".

    Example
    {
  "promos": [
    {
      "type": "PERCENTAGE",
      "discount": 100
    }
  ],
  "brand": "example",
  "comment": "Код курьера: 4563. Дополнительная информация о заказе...",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "isSlotDelivery": true,
    "phoneNumber": "+74732006745 доб. 12099",
    "realPhoneNumber": "79998887766",
    "deliveryAddress": {
      "city": "Москва",
      "entrance": "6",
      "flat": "234",
      "floor": "12",
      "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
      "house": "4к1",
      "intercom": "234",
      "latitude": "55.756994",
      "longitude": "37.614006",
      "region": "Видное",
      "street": "улица Викторенко"
    }
  },
  "discriminator": "yandex",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "Молоко Домик в деревне",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD"
  },
  "platform": "YE",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0"
}

  • Type: MarketplaceOrderCreate

    Информация о заказе с доставкой курьерами Партнера - "marketplace".

    Example
    {
  "promos": [
    {
      "type": "PERCENTAGE",
      "discount": 100
    }
  ],
  "platform": "YE",
  "discriminator": "marketplace",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "Молоко Домик в деревне",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "deliveryAddress": {
      "city": "Москва",
      "entrance": "6",
      "flat": "234",
      "floor": "12",
      "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
      "house": "4к1",
      "intercom": "234",
      "latitude": "55.756994",
      "longitude": "37.614006",
      "region": "Видное",
      "street": "улица Викторенко"
    },
    "deliveryDate": "1970-01-01T00:00:27.870000+00:20",
    "deliverySlot": {
      "from": "1970-01-01T00:00:27.870000+00:20",
      "slotId": "example",
      "to": "1970-01-01T00:00:27.870000+00:20"
    },
    "phoneNumber": "+74732006745 доб. 12099",
    "realPhoneNumber": "79998887766"
  },
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD",
    "change": 0,
    "deliveryFee": 179,
    "total": 1749
  },
  "comment": "Дополнительная информация о заказе...",
  "brand": "example"
}

  • Type: PickupOrderCreate

    Информация о заказе с самовывозом - "pickup".

    Example
    {
  "promos": [
    {
      "type": "PERCENTAGE",
      "discount": 100
    }
  ],
  "brand": "example",
  "comment": "Дополнительная информация о заказе...",
  "deliveryInfo": {
    "clientArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "clientName": "Иванов Иван Иванович",
    "phoneNumber": "+74732006745 доб. 12099",
    "realPhoneNumber": "79998887766"
  },
  "discriminator": "pickup",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "Молоко Домик в деревне",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD",
    "change": 0,
    "total": 1749
  },
  "platform": "YE",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "pickupPointId": "some-thing-id"
}

Promo

Скидка

Name

Description

discount

Type: number

Сумма скидки в валюте заказа

type

Type: string

Тип скидки. PERCENTAGE - процентная скидка. Список типов скидок может быть расширен в будущем

Example: PERCENTAGE
Example
{
  "type": "PERCENTAGE",
  "discount": 100
}

OrderPromos

Список скидок в заказе. В данный момент передаются только процентные скидки на товары от партнёра

Type: Promo[]

Example
[
  {
    "type": "PERCENTAGE",
    "discount": 100
  }
]

Brand

Бренд

Type: string

Example: example

YandexOrderComment

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

Type: string

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

ClientName

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

Type: string

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

CourierArrivementDate

Ориентировочная дата и время прибытия курьера в торговую точку.
В формате RFC3339 с дробной частью секунд: Y-m-dTH:i:s.uP.

Type: string<date-time>

Example: 2024-01-01T00:00:27.870000+00:20

PhoneNumber

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

Type: string

Example: +74732006745 доб. 12099

RealPhoneNumber

Номер телефона клиента без маскировки, передаётся с согласия пользователя на передачу данных и привязку карты лояльности. Требует поддержки только при интеграции программы лояльности партнёра в Яндекс Еде.

Type: string

Example: 79998887766

DeliveryAddressFull

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

Name

Description

full

Type: string

Полный адрес

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

latitude

Type: string

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

Example: 55.756994

longitude

Type: string

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

Example: 37.614006

city

Type: string

Город

Example: Москва

entrance

Type: string

Подъезд

Example: 6

flat

Type: string

Квартира

Example: 234

floor

Type: string

Этаж

Example: 12

house

Type: string

Дом

Example: 4к1

intercom

Type: string

Домофон

Example: 234

region

Type: string

Регион

Example: Видное

street

Type: string

Улица

Example: улица Викторенко
Example
{
  "city": "Москва",
  "entrance": "6",
  "flat": "234",
  "floor": "12",
  "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
  "house": "4к1",
  "intercom": "234",
  "latitude": "55.756994",
  "longitude": "37.614006",
  "region": "Видное",
  "street": "улица Викторенко"
}

YandexDeliveryInfo

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

Name

Description

courierArrivementDate

Type: CourierArrivementDate

Ориентировочная дата и время прибытия курьера в торговую точку.
В формате RFC3339 с дробной частью секунд: Y-m-dTH:i:s.uP.

Example: 2024-01-01T00:00:27.870000+00:20

clientName

Type: ClientName

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

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

deliveryAddress

Type: DeliveryAddressFull

Адрес доставки. Передаётся только аптечным
партнёрам. Используется для ведения журнала регистрации выполненных
заказов на стороне партнёра.

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

Example
{
  "city": "Москва",
  "entrance": "6",
  "flat": "234",
  "floor": "12",
  "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
  "house": "4к1",
  "intercom": "234",
  "latitude": "55.756994",
  "longitude": "37.614006",
  "region": "Видное",
  "street": "улица Викторенко"
}

isSlotDelivery

Type: boolean

Заказ со слотовой доставкой (доставка ко времени).

phoneNumber

Type: PhoneNumber

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

Example: +74732006745 доб. 12099

realPhoneNumber

Type: RealPhoneNumber

Номер телефона клиента без маскировки, передаётся с согласия пользователя на передачу данных и привязку карты лояльности. Требует поддержки только при интеграции программы лояльности партнёра в Яндекс Еде.

Example: 79998887766
Example
{
  "clientName": "Иванов Иван Иванович",
  "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
  "isSlotDelivery": true,
  "phoneNumber": "+74732006745 доб. 12099",
  "realPhoneNumber": "79998887766",
  "deliveryAddress": {
    "city": "Москва",
    "entrance": "6",
    "flat": "234",
    "floor": "12",
    "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
    "house": "4к1",
    "intercom": "234",
    "latitude": "55.756994",
    "longitude": "37.614006",
    "region": "Видное",
    "street": "улица Викторенко"
  }
}

YandexOrderDiscriminator

Дискриминатор схемы. Для заказов с доставкой курьерами-партнерами сервиса Яндекс Еды равен "yandex".

Type: string

Example: yandex

EatsId

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

Type: string

Example: 230130-1234567

ProductId

Уникальный идентификатор товара в системе Партнёра

Type: string

Max length: 64

Example: some-uniq-identifier

ProductName

Наименование товара.

Type: string

Example: Молоко Домик в деревне

OrderItemQuantity

Количество товара в заказе. Для весовых товаров количество передается в кг.

Type: number

OrderCreateItem

Name

Description

id

Type: ProductId

Уникальный идентификатор товара в системе Партнёра

Max length: 64

Example: some-uniq-identifier

price

Type: number

Цена одной единицы товара. Для весовых товаров цена передается за 1 кг.

quantity

Type: OrderItemQuantity

Количество товара в заказе. Для весовых товаров количество передается в кг.

Example: 3.4

name

Type: ProductName

Наименование товара.

Example: Молоко Домик в деревне

originPrice

Type: number

Исходная цена товара до применения рекомендаций.
Example
{
  "id": "some-uniq-identifier",
  "name": "Молоко Домик в деревне",
  "originPrice": 70,
  "price": 84,
  "quantity": 3.4
}

OrderCreateItems

Type: OrderCreateItem[]

Example
[
  {
    "id": "some-uniq-identifier",
    "name": "Молоко Домик в деревне",
    "originPrice": 70,
    "price": 84,
    "quantity": 3.4
  }
]

YandexOrderPaymentInfo

Name

Description

itemsCost

Type: number

Полная стоимость товаров в заказе

paymentType

Type: string

Информация о типе оплаты. CARD — это оплаченный заказ клиентом на стороне Яндекс Еды, CASH — это неоплаченный заказ (используется в основном при самовывозе алкоголя).

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

Platform

Идентификатор платформы, на которой был создан заказ: DC - Delivery Club, YE - Yandex Eda, LAVKA - Lavka, PHARMA - Аптеки, FLOWERS - Цветы.

Type: string

Enum: YE, DC, LAVKA, PHARMA, FLOWERS

RestaurantId

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

Type: string

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

YandexOrderCreate

Информация о заказе с доставкой курьерами-партнерами сервиса Яндекс Еды — "yandex".

Name

Description

comment

Type: YandexOrderComment

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

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

deliveryInfo

Type: YandexDeliveryInfo

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

Example
{
  "clientName": "Иванов Иван Иванович",
  "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
  "isSlotDelivery": true,
  "phoneNumber": "+74732006745 доб. 12099",
  "realPhoneNumber": "79998887766",
  "deliveryAddress": {
    "city": "Москва",
    "entrance": "6",
    "flat": "234",
    "floor": "12",
    "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
    "house": "4к1",
    "intercom": "234",
    "latitude": "55.756994",
    "longitude": "37.614006",
    "region": "Видное",
    "street": "улица Викторенко"
  }
}

discriminator

Type: YandexOrderDiscriminator

Дискриминатор схемы. Для заказов с доставкой курьерами-партнерами сервиса Яндекс Еды равен "yandex".

Example: yandex

eatsId

Type: EatsId

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

Example: 230130-1234567

items

Type: OrderCreateItems

Example
[
  {
    "id": "some-uniq-identifier",
    "name": "Молоко Домик в деревне",
    "originPrice": 70,
    "price": 84,
    "quantity": 3.4
  }
]

paymentInfo

Type: YandexOrderPaymentInfo

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

brand

Type: Brand

Бренд

Example: example

platform

Type: Platform

Идентификатор платформы, на которой был создан заказ: DC - Delivery Club, YE - Yandex Eda, LAVKA - Lavka, PHARMA - Аптеки, FLOWERS - Цветы.

Enum: YE, DC, LAVKA, PHARMA, FLOWERS

promos

Type: OrderPromos

Список скидок в заказе. В данный момент передаются только процентные скидки на товары от партнёра

Example
[
  {
    "type": "PERCENTAGE",
    "discount": 100
  }
]

restaurantId

Type: RestaurantId

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

Example: 937c57f6-4508-4858-be7f-20691a16fbb0
Example
{
  "promos": [
    {
      "type": "PERCENTAGE",
      "discount": 100
    }
  ],
  "brand": "example",
  "comment": "Код курьера: 4563. Дополнительная информация о заказе...",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "isSlotDelivery": true,
    "phoneNumber": "+74732006745 доб. 12099",
    "realPhoneNumber": "79998887766",
    "deliveryAddress": {
      "city": "Москва",
      "entrance": "6",
      "flat": "234",
      "floor": "12",
      "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
      "house": "4к1",
      "intercom": "234",
      "latitude": "55.756994",
      "longitude": "37.614006",
      "region": "Видное",
      "street": "улица Викторенко"
    }
  },
  "discriminator": "yandex",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "Молоко Домик в деревне",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD"
  },
  "platform": "YE",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0"
}

MarketplaceOrderDiscriminator

Дискриминатор схемы. Для заказов с доставкой курьерами Партнера равен "marketplace".

Type: string

Example: marketplace

DeliveryDate

Дата и время доставки, к которым клиент ожидает доставку заказа.
В формате RFC3339 с дробной частью секунд: Y-m-dTH:i:s.uP.

Type: string<date-time>

Example: 1970-01-01T00:00:27.870000+00:20

DeliverySlot

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

Name

Description

from

Type: string<date-time>

Начало слота доставки

Example: 1970-01-01T00:00:27.870000+00:20

to

Type: string<date-time>

Конец слота доставки

Example: 1970-01-01T00:00:27.870000+00:20

slotId

Type: string

Id слота партнёра. Передается в случае если слоты корзины передаются по API

Example: example
Example
{
  "from": "1970-01-01T00:00:27.870000+00:20",
  "slotId": "example",
  "to": "1970-01-01T00:00:27.870000+00:20"
}

MarketplaceCreateDeliveryInfo

Name

Description

clientName

Type: ClientName

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

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

deliveryAddress

Type: DeliveryAddressFull

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

Example
{
  "city": "Москва",
  "entrance": "6",
  "flat": "234",
  "floor": "12",
  "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
  "house": "4к1",
  "intercom": "234",
  "latitude": "55.756994",
  "longitude": "37.614006",
  "region": "Видное",
  "street": "улица Викторенко"
}

deliveryDate

Type: DeliveryDate

Дата и время доставки, к которым клиент ожидает доставку заказа.
В формате RFC3339 с дробной частью секунд: Y-m-dTH:i:s.uP.

Example: 1970-01-01T00:00:27.870000+00:20

phoneNumber

Type: PhoneNumber

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

Example: +74732006745 доб. 12099

deliverySlot

Type: DeliverySlot

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

Example
{
  "from": "1970-01-01T00:00:27.870000+00:20",
  "slotId": "example",
  "to": "1970-01-01T00:00:27.870000+00:20"
}

realPhoneNumber

Type: RealPhoneNumber

Номер телефона клиента без маскировки, передаётся с согласия пользователя на передачу данных и привязку карты лояльности. Требует поддержки только при интеграции программы лояльности партнёра в Яндекс Еде.

Example: 79998887766
Example
{
  "clientName": "Иванов Иван Иванович",
  "deliveryAddress": {
    "city": "Москва",
    "entrance": "6",
    "flat": "234",
    "floor": "12",
    "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
    "house": "4к1",
    "intercom": "234",
    "latitude": "55.756994",
    "longitude": "37.614006",
    "region": "Видное",
    "street": "улица Викторенко"
  },
  "deliveryDate": "1970-01-01T00:00:27.870000+00:20",
  "deliverySlot": {
    "from": "1970-01-01T00:00:27.870000+00:20",
    "slotId": "example",
    "to": "1970-01-01T00:00:27.870000+00:20"
  },
  "phoneNumber": "+74732006745 доб. 12099",
  "realPhoneNumber": "79998887766"
}

MarketplaceOrderPaymentInfo

All of 2 types

  • Type: YandexOrderPaymentInfo

    Example
    {
  "itemsCost": 1570,
  "paymentType": "CARD"
}
  • Type: object

    change

    Type: number

    Сумма, с которой потребуется сдача. Другими словами, это сумма которой клиент планирует расплатиться. Обычно оплата клиентом происходит картой на стороне Яндекса и Партнёрам данное поле передается пустым.

    deliveryFee

    Type: number

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

    total

    Type: number

    Общая стоимость заказа.
    Example
    {
  "change": 0,
  "deliveryFee": 179,
  "total": 1749
}
Example
{
  "itemsCost": 1570,
  "paymentType": "CARD",
  "change": 0,
  "deliveryFee": 179,
  "total": 1749
}

OrderComment

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

Type: string

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

MarketplaceOrderCreate

Информация о заказе с доставкой курьерами Партнера - "marketplace".

Name

Description

comment

Type: OrderComment

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

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

deliveryInfo

Type: MarketplaceCreateDeliveryInfo

Example
{
  "clientName": "Иванов Иван Иванович",
  "deliveryAddress": {
    "city": "Москва",
    "entrance": "6",
    "flat": "234",
    "floor": "12",
    "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
    "house": "4к1",
    "intercom": "234",
    "latitude": "55.756994",
    "longitude": "37.614006",
    "region": "Видное",
    "street": "улица Викторенко"
  },
  "deliveryDate": "1970-01-01T00:00:27.870000+00:20",
  "deliverySlot": {
    "from": "1970-01-01T00:00:27.870000+00:20",
    "slotId": "example",
    "to": "1970-01-01T00:00:27.870000+00:20"
  },
  "phoneNumber": "+74732006745 доб. 12099",
  "realPhoneNumber": "79998887766"
}

discriminator

Type: MarketplaceOrderDiscriminator

Дискриминатор схемы. Для заказов с доставкой курьерами Партнера равен "marketplace".

Example: marketplace

eatsId

Type: EatsId

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

Example: 230130-1234567

items

Type: OrderCreateItems

Example
[
  {
    "id": "some-uniq-identifier",
    "name": "Молоко Домик в деревне",
    "originPrice": 70,
    "price": 84,
    "quantity": 3.4
  }
]

paymentInfo

Type: MarketplaceOrderPaymentInfo

Example
{
  "itemsCost": 1570,
  "paymentType": "CARD",
  "change": 0,
  "deliveryFee": 179,
  "total": 1749
}

brand

Type: Brand

Бренд

Example: example

platform

Type: Platform

Идентификатор платформы, на которой был создан заказ: DC - Delivery Club, YE - Yandex Eda, LAVKA - Lavka, PHARMA - Аптеки, FLOWERS - Цветы.

Enum: YE, DC, LAVKA, PHARMA, FLOWERS

promos

Type: OrderPromos

Список скидок в заказе. В данный момент передаются только процентные скидки на товары от партнёра

Example
[
  {
    "type": "PERCENTAGE",
    "discount": 100
  }
]

restaurantId

Type: RestaurantId

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

Example: 937c57f6-4508-4858-be7f-20691a16fbb0
Example
{
  "promos": [
    {
      "type": "PERCENTAGE",
      "discount": 100
    }
  ],
  "platform": "YE",
  "discriminator": "marketplace",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "Молоко Домик в деревне",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Иванов Иван Иванович",
    "deliveryAddress": {
      "city": "Москва",
      "entrance": "6",
      "flat": "234",
      "floor": "12",
      "full": "Москва, улица Тверская, дом 1 строение 4, подъезд 2. 4-й этаж, код домофона: 123 К 4567",
      "house": "4к1",
      "intercom": "234",
      "latitude": "55.756994",
      "longitude": "37.614006",
      "region": "Видное",
      "street": "улица Викторенко"
    },
    "deliveryDate": "1970-01-01T00:00:27.870000+00:20",
    "deliverySlot": {
      "from": "1970-01-01T00:00:27.870000+00:20",
      "slotId": "example",
      "to": "1970-01-01T00:00:27.870000+00:20"
    },
    "phoneNumber": "+74732006745 доб. 12099",
    "realPhoneNumber": "79998887766"
  },
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD",
    "change": 0,
    "deliveryFee": 179,
    "total": 1749
  },
  "comment": "Дополнительная информация о заказе...",
  "brand": "example"
}

ClientArrivementDate

Ориентировочная дата и время прибытия клиента в торговую точку.
В формате RFC3339 с дробной частью секунд: Y-m-dTH:i:s.uP.

Type: string<date-time>

Example: 2024-01-01T00:00:27.870000+00:20

PickupDeliveryInfo

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

Name

Description

clientArrivementDate

Type: ClientArrivementDate

Ориентировочная дата и время прибытия клиента в торговую точку.
В формате RFC3339 с дробной частью секунд: Y-m-dTH:i:s.uP.

Example: 2024-01-01T00:00:27.870000+00:20

clientName

Type: ClientName

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

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

phoneNumber

Type: PhoneNumber

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

Example: +74732006745 доб. 12099

realPhoneNumber

Type: RealPhoneNumber

Номер телефона клиента без маскировки, передаётся с согласия пользователя на передачу данных и привязку карты лояльности. Требует поддержки только при интеграции программы лояльности партнёра в Яндекс Еде.

Example: 79998887766
Example
{
  "clientArrivementDate": "2024-01-01T00:00:27.870000+00:20",
  "clientName": "Иванов Иван Иванович",
  "phoneNumber": "+74732006745 доб. 12099",
  "realPhoneNumber": "79998887766"
}

PickupOrderDiscriminator

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

Type: string

Example: pickup

PickupOrderPaymentInfo

All of 2 types

  • Type: YandexOrderPaymentInfo

    Example
    {
  "itemsCost": 1570,
  "paymentType": "CARD"
}
  • Type: object

    change

    Type: number

    Сумма, с которой потребуется сдача. Другими словами, это сумма которой клиент планирует расплатиться. Обычно оплата клиентом происходит картой на стороне Яндекса и Партнёрам данное поле передается пустым.

    total

    Type: number

    Общая стоимость заказа.
    Example
    {
  "change": 0,
  "total": 1749
}
Example
{
  "itemsCost": 1570,
  "paymentType": "CARD",
  "change": 0,
  "total": 1749
}

PickupPointId

Идентификатор точки выдачи заказа, из которой клиент ожидает забрать заказ.

Type: string

Example: some-thing-id

PickupOrderCreate

Информация о заказе с самовывозом - "pickup".

Name

Description

comment

Type: OrderComment

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

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

deliveryInfo

Type: PickupDeliveryInfo

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

Example
{
  "clientArrivementDate": "2024-01-01T00:00:27.870000+00:20",
  "clientName": "Иванов Иван Иванович",
  "phoneNumber": "+74732006745 доб. 12099",
  "realPhoneNumber": "79998887766"
}

discriminator

Type: PickupOrderDiscriminator

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

Example: pickup

eatsId

Type: EatsId

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

Example: 230130-1234567

items

Type: OrderCreateItems

Example
[
  {
    "id": "some-uniq-identifier",
    "name": "Молоко Домик в деревне",
    "originPrice": 70,
    "price": 84,
    "quantity": 3.4
  }
]

paymentInfo

Type: PickupOrderPaymentInfo

Example
{
  "itemsCost": 1570,
  "paymentType": "CARD",
  "change": 0,
  "total": 1749
}

brand

Type: Brand

Бренд

Example: example

pickupPointId

Type: PickupPointId

Идентификатор точки выдачи заказа, из которой клиент ожидает забрать заказ.

Example: some-thing-id

platform

Type: Platform

Идентификатор платформы, на которой был создан заказ: DC - Delivery Club, YE - Yandex Eda, LAVKA - Lavka, PHARMA - Аптеки, FLOWERS - Цветы.

Enum: YE, DC, LAVKA, PHARMA, FLOWERS

promos

Type: OrderPromos

Список скидок в заказе. В данный момент передаются только процентные скидки на товары от партнёра

Example
[
  {
    "type": "PERCENTAGE",
    "discount": 100
  }
]

restaurantId

Type: RestaurantId

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

Example: 937c57f6-4508-4858-be7f-20691a16fbb0
Example
{
  "promos": [
    {
      "type": "PERCENTAGE",
      "discount": 100
    }
  ],
  "brand": "example",
  "comment": "Дополнительная информация о заказе...",
  "deliveryInfo": {
    "clientArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "clientName": "Иванов Иван Иванович",
    "phoneNumber": "+74732006745 доб. 12099",
    "realPhoneNumber": "79998887766"
  },
  "discriminator": "pickup",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "Молоко Домик в деревне",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD",
    "change": 0,
    "total": 1749
  },
  "platform": "YE",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "pickupPointId": "some-thing-id"
}

Responses

200 OK

Заказ успешно создан в системе Партнёра.

Body

application/json
{
  "result": "OK",
  "orderId": "03d3b69b-331c-4f84-b2c4-888b30320e63"
}

Name

Description

orderId

Type: OrderId

Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4.

Example: 03d3b69b-331c-4f84-b2c4-888b30320e63

result

Type: string

Example: OK

OrderId

Идентификатор заказа в системе Партнёра. Формат свободный. Рекомендуется UUID4.

Type: string

Example: 03d3b69b-331c-4f84-b2c4-888b30320e63

400 Bad Request

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

Body

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

Type: ErrorItem[]

ErrorItem

Name

Description

code

Type: integer

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

description

Type: string

Описание ошибки

Example: Description of error
Example
{
  "code": 400,
  "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

500 Internal Server Error

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

Body

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

Type: ErrorItem[]

Предыдущая
Введение
Следующая
❗️Информация о заказе