Get the order status in the restaurant system

Retrieves the order status

Request

GET

/order/{orderId}/status

Name

Description

orderId*

Type: string

Order identifier in the partner's system

Order status successfully retrieved

application/json

{
    "status": "NEW",
    "comment": "New order",
    "updatedAt": "1937-01-01T12:00:27.870000+00:20"
}

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`

Bad request. An array with an object from the error list is expected in the response body

application/json

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

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`

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

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

The order was not found in the system. An array with an object from the error list is expected in the response body

application/json

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

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

application/json

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