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 Example: `` |
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.
Enum: |
|
attributes |
Type: string[] Additional attributes when changing the order status, for example, a sign of payment upon cancellation Example |
|
comment |
Type: string Description of cancellation reasons (can be empty) Max length: Example: |
|
reason |
Type: string The reason for the cancellation of the order. It is transmitted only with the CANCELLED status Example: |
|
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: |
400 Bad Request
Bad request. An array with an object from the error list is expected in the response body
ErrorItem
|
Name |
Description |
|
code |
Type: integer Error code agreed with Yandex |
|
description |
Type: string Error message Example: |
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: |
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
500 Internal Server Error
Internal server errors. An array with an object from the error list is expected in the response body