Get currently unavailable menu items

Items with schematic or logical inconsistencies (too long string, stock equal to -10.00) may be ignored. The current version of the response model is application/vnd.eats.menu.availability.v2+json

Request

GET

/menu/{restaurantId}/availability

Path parameters

Name

Description

restaurantId*

Type: string

The ID of the restaurant in the partner's system

Responses

200 OK

Returns a list of currently unavailable menu items in the restaurant menu

Body

application/vnd.eats.menu.availability.v2+json

{
    "items": [
        {
            "itemId": "eff0cec0-058c-4d53-b524-1c04ac24fb51",
            "stock": 5
        }
    ],
    "modifiers": [
        {
            "modifierId": "eff0cec0-058c-4d53-b524-1c04ac24fb51",
            "stock": 5
        }
    ]
}

Name

Description

items*

Type: MenuAvailabilityItems[]

List of menu items for which availability needs to be changed

modifiers*

Type: MenuAvailabilityModifiers[]

List of dish modifiers for which availability needs to be change

MenuAvailabilityItems

Name

Description

itemId*

Type: string

Internal identifier of the dish in the partner's restaurant system. Can be any value convertible to a string. Recommendation - UUID4

Example: eff0cec0-058c-4d53-b524-1c04ac24fb51

stock

Type: integer<int32>

Stock in the restaurant. When 0, the dish disappears from the menu. Optional field. If stock is not passed for itemId, the stock of the dish is considered as 0.

Default: 0

Example: 5

MenuAvailabilityModifiers

Name

Description

modifierId*

Type: string

Internal identifier of the modifier in the partner's restaurant system. Can be any value convertible to a string. Recommendation - UUID4

Example: eff0cec0-058c-4d53-b524-1c04ac24fb51

stock

Type: integer<int32>

Stock in the restaurant. When 0, the modifier disappears from the menu. Optional field. If stock is not passed for modifierId, the stock of the modifier is considered as 0.

Default: 0

Example: 5

401 Unauthorized

Authorization failed - the token expired or was not passed in the request. A retry will be made

Body

application/json

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

Name

Description

reason*

Type: string

Reason for authorization failure

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

404 Not Found

No restaurant found. An array with an object from the error list is expected in the response body

Body

application/json

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

OrderStatusPut[]

OrderStatusPut

Name	Description
status*	Type: string Order ststus. Status description: TAKEN_BY_COURIER - courier picked up the order from the restaurant. DELIVERED – order completed. CANCELLED – order cancelled. Enum: `CANCELLED`, `TAKEN_BY_COURIER`, `DELIVERED`
attributes	Type: string[] Additional attributes when changing the order status, for example, a sign of payment upon cancellation Example: `paid`
comment	Type: string Description of cancellation reasons (can be empty) Example: `test` Max length: `500`
reason	Type: string The reason for the cancellation of the order. It is transmitted only with the CANCELLED status Example: `place.unable_to_call`
updatedAt	Type: string The date when the order status changed, in RFC 3339 format with fractional part of seconds (Y-m-d\TH:i:s.uP) Example: `1937-01-01T12:00:27.870000+00:20`

500 Internal Server Error

Internal server errors. An array with an object from the error list is expected in the response body

Body

application/json

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

OrderStatusPut[]

Was the article helpful?

Get the current restaurant menu

Get promotional dishes associated with the menu