Order status update from Yandex

Updating the order status in the partner's system by Yandex

Request

PUT

/order/{orderId}/status

Path parameters

Name

Description

orderId*

Type: string

Order identifier in the partner's system

Responses

204 No Content

The order status has been successfully updated

Body

application/json

{
    "status": "CANCELLED",
    "attributes": [
        "paid"
    ],
    "comment": "test",
    "reason": "place.unable_to_call",
    "updatedAt": "1937-01-01T12:00:27.870000+00:20"
}

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`

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

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`

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

OrderStatusPut[]

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 order status in the restaurant system

Update information about the courier