❗️Order information

Method for retrieving order information.

Request

GET

/order/{orderId}

Path parameters

Name

Description

orderId*

Type: string

Order identifier in Partner’s system.

Headers

Name

Description

Authorization*

Type: string

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

Responses

200 OK

Order information successfully transmitted.

Body

application/json

{
    "discriminator": "yandex",
    "eatsId": "230130-1234567",
    "items": [
        {
            "id": "some-uniq-identifier",
            "name": "“Milk Original\"",
            "originPrice": 70,
            "price": 84,
            "quantity": 3.4,
            "marking": [
                {
                    "datamatrix": "string",
                    "gisMarkCheck": {
                        "datetime": "2023-08-22 08:08:22.065000+00:00",
                        "id": "2ce10bdb-6510-4d37-be04-dd473b98c728"
                    },
                    "quantity": 0.5
                }
            ]
        }
    ]
}

Name	Description
...rest	oneOf YandexOrderUpdate Order information with Yandex Eats courier delivery – "yandex"
...rest	oneOf MarketplaceOrderUpdate Order information with Partner courier delivery – "marketplace".
...rest	oneOf PickupOrderUpdate Pickup order information.

YandexOrderUpdate

Order information with Yandex Eats courier delivery – "yandex"

Name	Description
discriminator*	Type: string Schema discriminator. For orders with Yandex Eats courier delivery equals "yandex". Example: `yandex`
eatsId*	Type: string End-to-end order identifier on Yandex Eats side in DDDDDD-DDDDDDD format. Example: `230130-1234567`
items*	Type: OrderUpdateItem[]

MarketplaceOrderUpdate

Order information with Partner courier delivery – "marketplace".

Name	Description
deliveryInfo*	Type: MarketplaceUpdateOrderDeliveryInfo Delivery information.
discriminator*	Type: string Schema discriminator. For orders with Partner courier delivery it equals "marketplace". Example: `marketplace`
eatsId*	Type: string End-to-end order identifier on Yandex Eats side in DDDDDD-DDDDDDD format. Example: `230130-1234567`
items*	Type: OrderUpdateItem[]
paymentInfo*	Type: MarketplaceOrderPaymentInfo
comment	Type: string Additional order information. Example: `Additional order information...`
platform	Type: Platform Platform identifier, DC – Delivery Club, YE – Yandex Eats, LAVKA – Lavka, VSEAPTEKI – Vseapteki. Example: `YE` Enum: `YE`, `DC`, `LAVKA`, `VSEAPTEKI`
restaurantId	Type: string Internal unique store identifier in partner system. Free format, UUID4 recommended. Example: `937c57f6-4508-4858-be7f-20691a16fbb0`

PickupOrderUpdate

Pickup order information.

Name	Description
deliveryInfo*	Type: PickupDeliveryInfo Delivery information.
discriminator*	Type: string Schema discriminator. For pickup orders it is equal to "pickup". Example: `pickup`
eatsId*	Type: string End-to-end order identifier on Yandex Eats side in DDDDDD-DDDDDDD format. Example: `230130-1234567`
items*	Type: OrderCreateItem[]
paymentInfo*	Type: YandexOrderPaymentInfo
brand	Type: string Brand
comment	Type: string Additional order information. Example: `Additional order information...`
platform	Type: Platform Platform identifier, DC – Delivery Club, YE – Yandex Eats, LAVKA – Lavka, VSEAPTEKI – Vseapteki. Example: `YE` Enum: `YE`, `DC`, `LAVKA`, `VSEAPTEKI`
restaurantId	Type: string Internal unique store identifier in partner system. Free format, UUID4 recommended. Example: `937c57f6-4508-4858-be7f-20691a16fbb0`

OrderUpdateItem

Name	Description
id*	Type: string Unique product identifier in the Partner’s system Example: `some-uniq-identifier` Max length: `64`
price*	Type: number<double> Price per unit of item. For catch-weight items price is specified per 1 kg. Example: `84`
quantity*	Type: number<float> Item quantity in order. For catch-weight items quantity is expressed in kg. Example: `3.4`
marking	Type: MarkingItem[] Object with item marking information.
name	Type: string Product name. Example: `“Milk Original"`
originPrice	Type: number<double> Original item price before applying recommendations. Example: `70`

MarketplaceUpdateOrderDeliveryInfo

Delivery information.

Name	Description
clientName*	Type: string Customer name in Yandex Eats service. Example: `Ivanov Ivan Ivanovich`
deliveryAddress*	Type: DeliveryAddress Delivery address information.
deliveryDate*	Type: string<date-time> 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: string 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.

MarketplaceOrderPaymentInfo

Name	Description
change*	Type: number<double> 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. Example: `0`
deliveryFee*	Type: number<double> Delivery cost. Example: `179`
itemsCost*	Type: number<double> Total cost of items in order Example: `1570`
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`
total	Type: number<double> Total order cost. Example: `1749`

Platform

Platform identifier, DC – Delivery Club, YE – Yandex Eats, LAVKA – Lavka, VSEAPTEKI – Vseapteki.

Type

Description

Platform

Example: YE

Enum: YE, DC, LAVKA, VSEAPTEKI

PickupDeliveryInfo

Delivery information.

Name	Description
clientArrivementDate*	Type: string<date-time> 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: string Customer name in Yandex Eats service. Example: `Ivanov Ivan Ivanovich`
phoneNumber*	Type: string Phone number for customer contact in international format. Consists of parts "+". May contain extension: "+ ext. " Example: `+74732006745 ext. 12099`
realPhoneNumber	Type: string С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`

OrderCreateItem

Name	Description
id*	Type: string Unique product identifier in the Partner’s system Example: `some-uniq-identifier` Max length: `64`
price*	Type: number<double> Price per unit of item. For catch-weight items price is specified per 1 kg. Example: `84`
quantity*	Type: number<float> Item quantity in order. For catch-weight items quantity is expressed in kg. Example: `3.4`
name	Type: string Product name. Example: `“Milk Original"`
originPrice	Type: number<double> Original item price before applying recommendations. Example: `70`

YandexOrderPaymentInfo

Name

Description

itemsCost*

Type: number<double>

Total cost of items in order

Example: 1570

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

MarkingItem

Name	Description
datamatrix*	Type: string Marking as string.
gisMarkCheck	Type: GisMarkCheck Marking verification results
quantity	Type: number<float> Product unit weight Example: `0.5`

DeliveryAddress

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`

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

GisMarkCheck

Marking verification results

Name

Description

datetime*

Type: string

Date and time of GIS request generation in ISO 8601 format.

Example: 2023-08-22 08:08:22.065000+00:00

id*

Type: string

GIS request ID

Example: 2ce10bdb-6510-4d37-be04-dd473b98c728

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"
    }
]

ErrorItem[]

ErrorItem

Name

Description

code*

Type: integer

Numeric error code agreed with Yango Deli.

Example: 400

description*

Type: string

Error description

Example: Description of error

401 Unauthorized

Authorisation failed – token expired or not provided in request.

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

404 Not Found

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"
    }
]

ErrorItem[]

500 Internal Server Error

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"
    }
]

ErrorItem[]

Was the article helpful?

❗️Order creation

❗️Order status