Detailed information about orders

Retrieve Detailed Order Information.

Limitations:
- A maximum of 100 orders can be sent in a request
- The history is stored for orders for the last 180 days

Note

This method is only available by subscription.

Request

POST

/v1/get-orders-details

Body

application/json

{
    "eats_ids": [
        "230328-354380"
    ]
}

Name

Description

eats_ids*

Type: string[]

List of order numbers to search for
End-to-end order identifier on the Yandex side in the format DDDDDD-DDDDDDDD

Example: 230328-354380

Min length: 13

Min items: 1

Max items: 100

Responses

200 OK

Body

application/json

{
    "orders": [
        {
            "eats_id": "230328-354380",
            "order_id": "string",
            "status": {
                "status": "NEW",
                "comment": "New order",
                "updatedAt": "1937-01-01T12:00:27.870000+00:20"
            },
            "items": [
                {
                    "id": "string",
                    "name": "string",
                    "quantity": 0,
                    "price": 123.78,
                    "original_price": 100.23,
                    "weight": 0,
                    "measure_unit": "string",
                    "modifications": [
                        {
                            "id": "string",
                            "group_id": "937c57f6-4508-4858-be7f-20691a16fbb1",
                            "name": "string",
                            "quantity": 0,
                            "price": 10.5
                        }
                    ]
                }
            ],
            "items_cost": 0
        }
    ],
    "not_found_eats_ids": [
        "230328-354380"
    ]
}

Name

Description

not_found_eats_ids*

Type: string[]

List of order numbers for which information not found or unavailable
End-to-end order identifier on the Yandex side in the format DDDDDD-DDDDDDDD

Example: 230328-354380

Min length: 13

orders*

Type: OrderDetails[]

List of orders with detailed information
Order with detailed information

OrderDetails

Order with detailed information

Name	Description
eats_id*	Type: string End-to-end order identifier on the Yandex side in the format DDDDDD-DDDDDDDD Example: `230328-354380` Min length: `13`
items*	Type: OrderItem[] The composition of the order Item with modificators
order_id*	Type: string Order identifier in the partner's system
status*	Type: OrderStatus
items_cost	Type: number The cost of the order for the partner minus the cost delivery (including partner discounts)

OrderItem

Item with modificators

Name	Description
id	Type: string Item ID on the partner's system
measure_unit	Type: string Units of weight measurement
modifications	Type: OrderItemOption[] Product Options Product Option
name	Type: string Item name
original_price	Type: number The cost of a given item excluding the cost of options Example: `100.23`
price	Type: number The cost of a given item including the cost of options Example: `123.78`
quantity	Type: number The number of products within this item
weight	Type: number Final weight of the product

OrderStatus

Name	Description
status*	Type: string Order status. Must be valid – for example, a prepared order cannot be made new again. Status transition is only possible in the specified direction: from NEW to DELIVERED. Exceptions: the order can move to the CANCELLED Status description: NEW – new, just sent to the restaurant. ACCEPTED_BY_RESTAURANT – order confirmed by the restaurant. COOKING – order preparation started. READY – order prepared. TAKEN_BY_COURIER – courier picked up the order from the restaurant. DELIVERED – order completed. CANCELLED – order cancelled. NEW -> ACCEPTED_BY_RESTAURANT -> COOKING -> READY -> TAKEN_BY_COURIER -> DELIVERED. From any status -> CANCELLED Enum: `NEW`, `ACCEPTED_BY_RESTAURANT`, `COOKING`, `READY`, `TAKEN_BY_COURIER`, `DELIVERED`, `CANCELLED`
comment	Type: string Status change comment Example: `New order` Max length: `500`
updatedAt	Type: string<date-time> Date when the order status changed, in RFC3339 format with fractional seconds (Y-m-d\TH:i:s.uP) Example: `1937-01-01T12:00:27.870000+00:20`

OrderItemOption

Product Option

Name	Description
id*	Type: string Option's ID in the partner's system
price*	Type: number The price of a product option Example: `10.5`
quantity*	Type: integer The number of options within the item
group_id	Type: string The ID of the group in the partner system to which the option belongs Example: `937c57f6-4508-4858-be7f-20691a16fbb1`
name	Type: string Option name

400 Bad Request

Request error

Body

application/json

{
    "message": "string",
    "code": "string"
}

Name

Description

code*

Type: string

Error code

message*

Type: string

Error message

500 Internal Server Error

Internal server error

Body

application/json

{
    "message": "string",
    "code": "string"
}

Name

Description

code*

Type: string

Error code

message*

Type: string

Error message

Was the article helpful?

Get the order history

Retrieve list of restaurants with active high-demand status