Get the order status in the restaurant system

Retrieves the order status

Request

GET

/order/{orderId}/status

Path parameters

Name

Description

orderId

Type: string

Order identifier in the partner's system

Example: ``

Responses

200 OK

Order status successfully retrieved

Body

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

Max length: 500

Example: New order

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

400 Bad Request

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

Body

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

Type: ErrorItem[]

ErrorItem

Name

Description

code

Type: integer

Error code agreed with Yandex

description

Type: string

Error message

Example: Description of error

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

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

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

Body

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

Type: ErrorItem[]

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

Type: ErrorItem[]