❗️Order creation

Method for creating an order in Partner’s system.

  • YandexOrder – order schema for Yango Deli courier delivery.
  • MarketplaceOrder – order schema for Partner courier delivery.
  • PickupOrder – order schema for pickup.

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

Примечание

Content-type headers in request and response differ.

Request

POST

/order

Headers

Name

Description

Authorization

Type: string

Token received in response to the /security/oauth/token request

Example: ``

Body

application/vnd.eats.order.v2+json
{
  "brand": "example",
  "comment": "Courier code: 4563. Additional order information...",
  "deliveryInfo": {
    "clientName": "Ivanov Ivan Ivanovich",
    "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "isSlotDelivery": true,
    "phoneNumber": "+74732006745 ext. 12099",
    "realPhoneNumber": "79998887766"
  },
  "discriminator": "yandex",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "“Milk Original\"",
      "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

    Order information with Yandex Eats courier delivery – "yandex".

    Example
    {
  "brand": "example",
  "comment": "Courier code: 4563. Additional order information...",
  "deliveryInfo": {
    "clientName": "Ivanov Ivan Ivanovich",
    "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "isSlotDelivery": true,
    "phoneNumber": "+74732006745 ext. 12099",
    "realPhoneNumber": "79998887766"
  },
  "discriminator": "yandex",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "“Milk Original\"",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD"
  },
  "platform": "YE",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0"
}

  • Type: MarketplaceOrderCreate

    Order information with Partner courier delivery – "marketplace".

    Example
    {
  "platform": "YE",
  "discriminator": "marketplace",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "“Milk Original\"",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Ivanov Ivan Ivanovich",
    "deliveryAddress": {
      "city": "Moscow",
      "entrance": "6",
      "flat": "234",
      "floor": "12",
      "full": "Moscow, Tverskaya Street, building 1 structure 4, entrance 2. 4th floor, intercom code: 123 K 4567",
      "house": "4k1",
      "intercom": "234",
      "latitude": "55.756994",
      "longitude": "37.614006",
      "region": "Vidnoye",
      "street": "Viktorenko 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 ext. 12099",
    "realPhoneNumber": "79998887766"
  },
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD",
    "change": 0,
    "deliveryFee": 179,
    "total": 1749
  },
  "comment": "Additional order information...",
  "brand": "example"
}

  • Type: PickupOrderCreate

    Pickup order information.

    Example
    {
  "brand": "example",
  "comment": "Additional order information...",
  "deliveryInfo": {
    "clientArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "clientName": "Ivanov Ivan Ivanovich",
    "phoneNumber": "+74732006745 ext. 12099",
    "realPhoneNumber": "79998887766"
  },
  "discriminator": "pickup",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "“Milk Original\"",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD"
  },
  "platform": "YE",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "pickupPointId": "some-thing-id"
}

Brand

Brand

Type: string

Example: example

YandexOrderComment

Contains the courier code and additional order information.

Type: string

Example: Courier code: 4563. Additional order information...

ClientName

Customer name in Yandex Eats service.

Type: string

Example: Ivanov Ivan Ivanovich

CourierArrivementDate

Date when the customer will arrive at the store, in RFC3339 format with fractional seconds (Y-m-d\TH:i:s.uP). Fractional seconds part is mandatory.

Type: string<date-time>

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

PhoneNumber

Phone number for customer contact in international format. Consists of parts "+". May contain extension: "+ ext. "

Type: string

Example: +74732006745 ext. 12099

RealPhoneNumber

Сustomer phone number without masking, provided with user consent for data transfer and loyalty card binding. Support required only when integrating the partner’s loyalty program in Yandex Eats.

Type: string

Example: 79998887766

YandexDeliveryInfo

Delivery information

Name

Description

courierArrivementDate

Type: CourierArrivementDate

Date when the customer will arrive at the store, in RFC3339 format with fractional seconds (Y-m-d\TH:i:s.uP). Fractional seconds part is mandatory.

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

clientName

Type: ClientName

Customer name in Yandex Eats service.

Example: Ivanov Ivan Ivanovich

isSlotDelivery

Type: boolean

Order with slot delivery (timed delivery).

phoneNumber

Type: PhoneNumber

Phone number for customer contact in international format. Consists of parts "+". May contain extension: "+ ext. "

Example: +74732006745 ext. 12099

realPhoneNumber

Type: RealPhoneNumber

Сustomer phone number without masking, provided with user consent for data transfer and loyalty card binding. Support required only when integrating the partner’s loyalty program in Yandex Eats.

Example: 79998887766
Example
{
  "clientName": "Ivanov Ivan Ivanovich",
  "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
  "isSlotDelivery": true,
  "phoneNumber": "+74732006745 ext. 12099",
  "realPhoneNumber": "79998887766"
}

YandexOrderDiscriminator

Schema discriminator. For orders with Yandex Eats courier delivery equals "yandex".

Type: string

Example: yandex

EatsId

End-to-end order identifier on Yandex Eats side in DDDDDD-DDDDDDD format.

Type: string

Example: 230130-1234567

ProductId

Unique product identifier in the Partner’s system

Type: string

Max length: 64

Example: some-uniq-identifier

ProductName

Product name.

Type: string

Example: “Milk Original"

OrderItemQuantity

Item quantity in order. For catch-weight items quantity is expressed in kg.

Type: number

OrderCreateItem

Name

Description

id

Type: ProductId

Unique product identifier in the Partner’s system

Max length: 64

Example: some-uniq-identifier

price

Type: number

Price per unit of item. For catch-weight items price is specified per 1 kg.

quantity

Type: OrderItemQuantity

Item quantity in order. For catch-weight items quantity is expressed in kg.

Example: 3.4

name

Type: ProductName

Product name.

Example: “Milk Original"

originPrice

Type: number

Original item price before applying recommendations.
Example
{
  "id": "some-uniq-identifier",
  "name": "“Milk Original\"",
  "originPrice": 70,
  "price": 84,
  "quantity": 3.4
}

OrderCreateItems

Type: OrderCreateItem[]

Example
[
  {
    "id": "some-uniq-identifier",
    "name": "“Milk Original\"",
    "originPrice": 70,
    "price": 84,
    "quantity": 3.4
  }
]

YandexOrderPaymentInfo

Name

Description

itemsCost

Type: number

Total cost of items in order

paymentType

Type: string

Payment type information. CARD – order paid by customer on Yandex Eats side, CASH – unpaid order (mainly used for alcohol pickup).

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

Platform

Platform identifier, DC – Delivery Club, YE – Yandex Eats, LAVKA – Lavka, PHARMA – Pharma, FLOWERS – Flowers.

Type: string

Enum: YE, DC, LAVKA, PHARMA, FLOWERS

RestaurantId

Internal unique store identifier in partner system. Free format, UUID4 recommended.

Type: string

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

YandexOrderCreate

Order information with Yandex Eats courier delivery – "yandex".

Name

Description

comment

Type: YandexOrderComment

Contains the courier code and additional order information.

Example: Courier code: 4563. Additional order information...

deliveryInfo

Type: YandexDeliveryInfo

Delivery information

Example
{
  "clientName": "Ivanov Ivan Ivanovich",
  "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
  "isSlotDelivery": true,
  "phoneNumber": "+74732006745 ext. 12099",
  "realPhoneNumber": "79998887766"
}

discriminator

Type: YandexOrderDiscriminator

Schema discriminator. For orders with Yandex Eats courier delivery equals "yandex".

Example: yandex

eatsId

Type: EatsId

End-to-end order identifier on Yandex Eats side in DDDDDD-DDDDDDD format.

Example: 230130-1234567

items

Type: OrderCreateItems

Example
[
  {
    "id": "some-uniq-identifier",
    "name": "“Milk Original\"",
    "originPrice": 70,
    "price": 84,
    "quantity": 3.4
  }
]

paymentInfo

Type: YandexOrderPaymentInfo

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

brand

Type: Brand

Brand

Example: example

platform

Type: Platform

Platform identifier, DC – Delivery Club, YE – Yandex Eats, LAVKA – Lavka, PHARMA – Pharma, FLOWERS – Flowers.

Enum: YE, DC, LAVKA, PHARMA, FLOWERS

restaurantId

Type: RestaurantId

Internal unique store identifier in partner system. Free format, UUID4 recommended.

Example: 937c57f6-4508-4858-be7f-20691a16fbb0
Example
{
  "brand": "example",
  "comment": "Courier code: 4563. Additional order information...",
  "deliveryInfo": {
    "clientName": "Ivanov Ivan Ivanovich",
    "courierArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "isSlotDelivery": true,
    "phoneNumber": "+74732006745 ext. 12099",
    "realPhoneNumber": "79998887766"
  },
  "discriminator": "yandex",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "“Milk Original\"",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD"
  },
  "platform": "YE",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0"
}

MarketplaceOrderDiscriminator

Schema discriminator. For orders with Partner courier delivery it equals "marketplace".

Type: string

Example: marketplace

DeliveryAddressFull

Delivery address information.

Name

Description

full

Type: string

Full address

Example: Moscow, Tverskaya Street, building 1 structure 4, entrance 2. 4th floor, intercom code: 123 K 4567

latitude

Type: string

Latitude of delivery point

Example: 55.756994

longitude

Type: string

Longitude of delivery point

Example: 37.614006

city

Type: string

City

Example: Moscow

entrance

Type: string

Entrance

Example: 6

flat

Type: string

Apartment

Example: 234

floor

Type: string

Floor

Example: 12

house

Type: string

Building

Example: 4k1

intercom

Type: string

Intercom

Example: 234

region

Type: string

Region

Example: Vidnoye

street

Type: string

Street

Example: Viktorenko street
Example
{
  "city": "Moscow",
  "entrance": "6",
  "flat": "234",
  "floor": "12",
  "full": "Moscow, Tverskaya Street, building 1 structure 4, entrance 2. 4th floor, intercom code: 123 K 4567",
  "house": "4k1",
  "intercom": "234",
  "latitude": "55.756994",
  "longitude": "37.614006",
  "region": "Vidnoye",
  "street": "Viktorenko street"
}

DeliveryDate

Delivery date (when customer expects order delivery), in RFC3339 format with fractional seconds (Y-m-d\TH:i:s.uP).

Type: string<date-time>

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

DeliverySlot

Delivery slot information.

Name

Description

from

Type: string<date-time>

Delivery slot start

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

to

Type: string<date-time>

Delivery slot end.

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

slotId

Type: string

Slot ID

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

Customer name in Yandex Eats service.

Example: Ivanov Ivan Ivanovich

deliveryAddress

Type: DeliveryAddressFull

Delivery address information.

Example
{
  "city": "Moscow",
  "entrance": "6",
  "flat": "234",
  "floor": "12",
  "full": "Moscow, Tverskaya Street, building 1 structure 4, entrance 2. 4th floor, intercom code: 123 K 4567",
  "house": "4k1",
  "intercom": "234",
  "latitude": "55.756994",
  "longitude": "37.614006",
  "region": "Vidnoye",
  "street": "Viktorenko street"
}

deliveryDate

Type: DeliveryDate

Delivery date (when customer expects order delivery), in RFC3339 format with fractional seconds (Y-m-d\TH:i:s.uP).

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

phoneNumber

Type: PhoneNumber

Phone number for customer contact in international format. Consists of parts "+". May contain extension: "+ ext. "

Example: +74732006745 ext. 12099

deliverySlot

Type: DeliverySlot

Delivery slot information.

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

realPhoneNumber

Type: RealPhoneNumber

Сustomer phone number without masking, provided with user consent for data transfer and loyalty card binding. Support required only when integrating the partner’s loyalty program in Yandex Eats.

Example: 79998887766
Example
{
  "clientName": "Ivanov Ivan Ivanovich",
  "deliveryAddress": {
    "city": "Moscow",
    "entrance": "6",
    "flat": "234",
    "floor": "12",
    "full": "Moscow, Tverskaya Street, building 1 structure 4, entrance 2. 4th floor, intercom code: 123 K 4567",
    "house": "4k1",
    "intercom": "234",
    "latitude": "55.756994",
    "longitude": "37.614006",
    "region": "Vidnoye",
    "street": "Viktorenko 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 ext. 12099",
  "realPhoneNumber": "79998887766"
}

MarketplaceOrderPaymentInfo

All of 2 types

  • Type: YandexOrderPaymentInfo

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

    change

    Type: number

    Payment amount requiring change. In other words, this is the amount the customer plans to pay with. Usually customer payment occurs by card on Yandex side and this field is transmitted empty to Partners.

    deliveryFee

    Type: number

    Delivery cost.

    total

    Type: number

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

OrderComment

Additional order information.

Type: string

Example: Additional order information...

MarketplaceOrderCreate

Order information with Partner courier delivery – "marketplace".

Name

Description

comment

Type: OrderComment

Additional order information.

Example: Additional order information...

deliveryInfo

Type: MarketplaceCreateDeliveryInfo

Example
{
  "clientName": "Ivanov Ivan Ivanovich",
  "deliveryAddress": {
    "city": "Moscow",
    "entrance": "6",
    "flat": "234",
    "floor": "12",
    "full": "Moscow, Tverskaya Street, building 1 structure 4, entrance 2. 4th floor, intercom code: 123 K 4567",
    "house": "4k1",
    "intercom": "234",
    "latitude": "55.756994",
    "longitude": "37.614006",
    "region": "Vidnoye",
    "street": "Viktorenko 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 ext. 12099",
  "realPhoneNumber": "79998887766"
}

discriminator

Type: MarketplaceOrderDiscriminator

Schema discriminator. For orders with Partner courier delivery it equals "marketplace".

Example: marketplace

eatsId

Type: EatsId

End-to-end order identifier on Yandex Eats side in DDDDDD-DDDDDDD format.

Example: 230130-1234567

items

Type: OrderCreateItems

Example
[
  {
    "id": "some-uniq-identifier",
    "name": "“Milk Original\"",
    "originPrice": 70,
    "price": 84,
    "quantity": 3.4
  }
]

paymentInfo

Type: MarketplaceOrderPaymentInfo

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

brand

Type: Brand

Brand

Example: example

platform

Type: Platform

Platform identifier, DC – Delivery Club, YE – Yandex Eats, LAVKA – Lavka, PHARMA – Pharma, FLOWERS – Flowers.

Enum: YE, DC, LAVKA, PHARMA, FLOWERS

restaurantId

Type: RestaurantId

Internal unique store identifier in partner system. Free format, UUID4 recommended.

Example: 937c57f6-4508-4858-be7f-20691a16fbb0
Example
{
  "platform": "YE",
  "discriminator": "marketplace",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "“Milk Original\"",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "deliveryInfo": {
    "clientName": "Ivanov Ivan Ivanovich",
    "deliveryAddress": {
      "city": "Moscow",
      "entrance": "6",
      "flat": "234",
      "floor": "12",
      "full": "Moscow, Tverskaya Street, building 1 structure 4, entrance 2. 4th floor, intercom code: 123 K 4567",
      "house": "4k1",
      "intercom": "234",
      "latitude": "55.756994",
      "longitude": "37.614006",
      "region": "Vidnoye",
      "street": "Viktorenko 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 ext. 12099",
    "realPhoneNumber": "79998887766"
  },
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD",
    "change": 0,
    "deliveryFee": 179,
    "total": 1749
  },
  "comment": "Additional order information...",
  "brand": "example"
}

ClientArrivementDate

Date when the courier is expected to arrive at the store, in RFC3339 format with fractional seconds (Y-m-d\TH:i:s.uP). Make sure to include fractional seconds.

Type: string<date-time>

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

PickupDeliveryInfo

Delivery information.

Name

Description

clientArrivementDate

Type: ClientArrivementDate

Date when the courier is expected to arrive at the store, in RFC3339 format with fractional seconds (Y-m-d\TH:i:s.uP). Make sure to include fractional seconds.

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

clientName

Type: ClientName

Customer name in Yandex Eats service.

Example: Ivanov Ivan Ivanovich

phoneNumber

Type: PhoneNumber

Phone number for customer contact in international format. Consists of parts "+". May contain extension: "+ ext. "

Example: +74732006745 ext. 12099

realPhoneNumber

Type: RealPhoneNumber

Сustomer phone number without masking, provided with user consent for data transfer and loyalty card binding. Support required only when integrating the partner’s loyalty program in Yandex Eats.

Example: 79998887766
Example
{
  "clientArrivementDate": "2024-01-01T00:00:27.870000+00:20",
  "clientName": "Ivanov Ivan Ivanovich",
  "phoneNumber": "+74732006745 ext. 12099",
  "realPhoneNumber": "79998887766"
}

PickupOrderDiscriminator

Schema discriminator. For pickup orders it is equal to "pickup".

Type: string

Example: pickup

PickupPointId

Identifier of the order pickup point from which customer expects to collect the order.

Type: string

Example: some-thing-id

PickupOrderCreate

Pickup order information.

Name

Description

comment

Type: OrderComment

Additional order information.

Example: Additional order information...

deliveryInfo

Type: PickupDeliveryInfo

Delivery information.

Example
{
  "clientArrivementDate": "2024-01-01T00:00:27.870000+00:20",
  "clientName": "Ivanov Ivan Ivanovich",
  "phoneNumber": "+74732006745 ext. 12099",
  "realPhoneNumber": "79998887766"
}

discriminator

Type: PickupOrderDiscriminator

Schema discriminator. For pickup orders it is equal to "pickup".

Example: pickup

eatsId

Type: EatsId

End-to-end order identifier on Yandex Eats side in DDDDDD-DDDDDDD format.

Example: 230130-1234567

items

Type: OrderCreateItems

Example
[
  {
    "id": "some-uniq-identifier",
    "name": "“Milk Original\"",
    "originPrice": 70,
    "price": 84,
    "quantity": 3.4
  }
]

paymentInfo

Type: YandexOrderPaymentInfo

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

brand

Type: Brand

Brand

Example: example

pickupPointId

Type: PickupPointId

Identifier of the order pickup point from which customer expects to collect the order.

Example: some-thing-id

platform

Type: Platform

Platform identifier, DC – Delivery Club, YE – Yandex Eats, LAVKA – Lavka, PHARMA – Pharma, FLOWERS – Flowers.

Enum: YE, DC, LAVKA, PHARMA, FLOWERS

restaurantId

Type: RestaurantId

Internal unique store identifier in partner system. Free format, UUID4 recommended.

Example: 937c57f6-4508-4858-be7f-20691a16fbb0
Example
{
  "brand": "example",
  "comment": "Additional order information...",
  "deliveryInfo": {
    "clientArrivementDate": "2024-01-01T00:00:27.870000+00:20",
    "clientName": "Ivanov Ivan Ivanovich",
    "phoneNumber": "+74732006745 ext. 12099",
    "realPhoneNumber": "79998887766"
  },
  "discriminator": "pickup",
  "eatsId": "230130-1234567",
  "items": [
    {
      "id": "some-uniq-identifier",
      "name": "“Milk Original\"",
      "originPrice": 70,
      "price": 84,
      "quantity": 3.4
    }
  ],
  "paymentInfo": {
    "itemsCost": 1570,
    "paymentType": "CARD"
  },
  "platform": "YE",
  "restaurantId": "937c57f6-4508-4858-be7f-20691a16fbb0",
  "pickupPointId": "some-thing-id"
}

Responses

200 OK

Order successfully created in Partner’s system.

Body

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

Name

Description

orderId

Type: OrderId

Order identifier in the Partner’s system. Free format. UUID4 is recommended.

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

result

Type: string

Example: OK

OrderId

Order identifier in the Partner’s system. Free format. UUID4 is recommended.

Type: string

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

400 Bad Request

Request error. The response is expected to contain an array with an object from the error list.

Body

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

Type: ErrorItem[]

ErrorItem

Name

Description

code

Type: integer

Numeric error code agreed with Yango Deli.

description

Type: string

Error description

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

401 Unauthorized

Authorisation failed.

Body

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

Name

Description

reason

Type: string

The reason why authorisation failed.

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

500 Internal Server Error

Internal server errors. The response is expected to contain an array with an object from the error list.

Body

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

Type: ErrorItem[]

Previous
Introduction
Next
❗️Order information