---
metadata:
  - name: generator
    content: Diplodoc Platform v5.48.2
alternate:
  - https://yandex.com/dev/eda-vendor/doc/en/ref/Orders/partner.order.status.put.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/eda-vendor/doc/en/llms.txt

<div class="openapi">

# Order status update from Yandex

<!-- markdownlint-disable-file -->

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

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-put);margin-bottom: 12px">

<div class="openapi__request">

PUT {.openapi__method}
```text translate=no
/order/{orderId}/status
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_orderId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Order identifier in the partner's system

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

## Responses

<div class="openapi__response__code__204">

## 204 No Content

The order status has been successfully updated

<div class="openapi-entity">

### Body

{% cut "application/json" %}

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

{% endcut %}

#|
|| **Name** | **Description** ||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Order ststus.
Status description:
- TAKEN_BY_COURIER - courier picked up the order from the restaurant.
- DELIVERED – order completed.
- CANCELLED – order cancelled.

_Enum:_{.json-schema-reset .json-schema-value} `CANCELLED`, `TAKEN_BY_COURIER`, `DELIVERED`
{.table-cell}
||
||

_attributes_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[]

Additional attributes when changing the order status, for example, a sign of payment upon cancellation

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "paid"
]
```

{% endcut %}
{.table-cell}
||
||

_comment_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Description of cancellation reasons (can be empty)

_Max length:_{.json-schema-reset .json-schema-assertion} `500`

_Example:_{.json-schema-reset .json-schema-example} `test`
{.table-cell}
||
||

_reason_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

The reason for the cancellation of the order. It is transmitted only with the CANCELLED status

_Example:_{.json-schema-reset .json-schema-example} `place.unable_to_call`
{.table-cell}
||
||

_updatedAt_{.json-schema-reset .json-schema-property}
{.table-cell}|
**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:_{.json-schema-reset .json-schema-example} `1937-01-01T12:00:27.870000+00:20`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Bad request. **_An array with an object from the error list is expected in the response body_**

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
[
  {
    "code": 100,
    "description": "Description of error"
  }
]
```

{% endcut %}

**Type**: [ErrorItem](#entity-ErrorItem)[]

</div>

<div class="openapi-entity">

### ErrorItem {#entity-ErrorItem}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Error code agreed with Yandex
{.table-cell}
||
||

_description_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Error message

_Example:_{.json-schema-reset .json-schema-example} `Description of error`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "code": 100,
  "description": "Description of error"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__401">

## 401 Unauthorized

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "reason": "Access token has been expired. You should request a new one"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_reason_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Reason for authorization failure

_Example:_{.json-schema-reset .json-schema-example} `Access token has been expired. You should request a new one`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__404">

## 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_**

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
[
  {
    "code": 100,
    "description": "Description of error"
  }
]
```

{% endcut %}

**Type**: [ErrorItem](#entity-ErrorItem)[]

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

Internal server errors. **_An array with an object from the error list is expected in the response body_**

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
[
  {
    "code": 100,
    "description": "Description of error"
  }
]
```

{% endcut %}

**Type**: [ErrorItem](#entity-ErrorItem)[]

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.