Запись кодов маркировки «Честный знак»

Записывает коды маркировки «Честный знак» для позиций заказа.

Правила и ограничения:

Каждая позиция заказа — это одна единица товара, поэтому позиции соответствует ровно один код маркировки. Идентификаторы позиций возвращает GET /v1/orders/{id} в поле delivery_chunks[].items[].id.
Все переданные позиции должны принадлежать указанному заказу, order_item_id не должны повторяться.
Код передается целиком, вместе с криптохвостом.
Для снятия ранее записанного кода передайте "marking_code": null.
Метод идемпотентен: если любой код не проходит проверку, запрос отклоняется, при этом коды не записываются.

Request

POST

https://api.kit.yandex.net/v1/orders/{id}/marking-codes

Body

application/json

{
  "items": [
    {
      "order_item_id": "00000000-0000-0000-0000-000000000001",
      "marking_code": "0104670147122765215Fx_t42mlIYny91EE1192Z5CcNr9XGy6luZHI79Fy20sQtEva56kNkxAPI5eGiIw="
    }
  ]
}

Name

Description

items

Type: OrderMarkingCode[]

Позиции заказа с кодами маркировки. Позиция не может повторяться.

Min items: 1

Max items: 100

Example

[
  {
    "order_item_id": "00000000-0000-0000-0000-000000000001",
    "marking_code": "0104670147122765215Fx_t42mlIYny91EE1192Z5CcNr9XGy6luZHI79Fy20sQtEva56kNkxAPI5eGiIw="
  }
]

OrderItemID

Идентификатор позиции заказа.

Type: string<uuid>

Example: 00000000-0000-0000-0000-000000000001

OrderMarkingCode

Код маркировки «Честный знак» для позиции заказа.

Name

Description

marking_code

Type: string | null

Код маркировки «Честный знак» целиком, вместе с криптохвостом. null — снять ранее записанный код с позиции.

Example: 0104670147122765215Fx_t42mlIYny91EE1192Z5CcNr9XGy6luZHI79Fy20sQtEva56kNkxAPI5eGiIw=

order_item_id

Type: OrderItemID

Идентификатор позиции заказа.

Example: 00000000-0000-0000-0000-000000000001

Example

{
  "order_item_id": "00000000-0000-0000-0000-000000000001",
  "marking_code": "0104670147122765215Fx_t42mlIYny91EE1192Z5CcNr9XGy6luZHI79Fy20sQtEva56kNkxAPI5eGiIw="
}

Responses

204 No Content

Коды маркировки успешно записаны.

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

404 Not Found

Ресурс не найден.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

Была ли статья полезна?

Завершение доставки заказа

Список ресурсов