# Order preparation
{% list tabs %}
- Info
**The method is available for models: [FBS](https://yandex.ru/dev/market/partner-api/doc/en/overview/fbs.md), [Express](https://yandex.ru/dev/market/partner-api/doc/en/overview/express.md) and [DBS](https://yandex.ru/dev/market/partner-api/doc/en/overview/dbs.md).**
{% cut "**If you are using an API Key token, one of the accesses in the list is required to call the method**" %}
* inventory-and-order-processing — [Order processing and inventory](https://yandex.ru/dev/market/partner-api/doc/en/_auto/scopes_summary/pages/inventory-and-order-processing.md)
* all-methods — Full account management
{% endcut %}
{% note tip "Подходит и для DBS" %}
The request is designed to work with FBS-orders, but you can use it for processing DBS- orders, if it is convenient.
{% endnote %}
Allows you to perform three operations:
* send information about the distribution of goods by boxes to the Market;
* send the labeling codes for the products to the Market;
* remove an item from the order if it is not in stock.
If you need to fix something in the transmitted data, just repeat the request. — This can be done as many times as you want before the order status is changed. **Ready for shipment**. ⚠️ If you change the layout after printing and pasting the labels, do not forget to reprint them and paste them again.
{% cut "Как передать информацию о распределении товаров" %}
In this request, you need to send the Market a list of boxes and specify which products are in each of them. There are two types of boxes:
* **Containing the entire product.** Such a box can contain any number of items of any kind.
* **Containing a part of the product.** Such boxes contain one part of one product. For example, one contains an external air conditioner unit, and the other — the indoor unit.
⚠️ One box cannot contain both the whole goods and parts of the goods.
{% endcut %}
{% cut "Как передавать коды маркировки и получать статус их проверки" %}
{% note info "Маркировка товаров в системе [«Честный ЗНАК»](https://честныйзнак.рф/) необязательна для заказов от физических лиц" %}
For business orders, you still need to send the labeling codes.
{% endnote %}
If the order contains products subject to labeling, the corresponding unique codes must be provided in the request. [What is labeling?](https://yandex.ru/support/marketplace/orders/cz.html)
The following types of codes are accepted:
* Codes in the system ["An honest SIGN"](https://честныйзнак.рф/) or [«ASL BELGISI»](https://aslbelgisi.uz) (for sellers Market Yandex Go).
* WIN for jewelry.
* RNPT and GTD for imported traceable goods.
For each item in the order that requires labeling, you need to provide a list of codes. — one for each item. For example, if there are two pairs of slippers and one pair of shoes in the order, you will get a list of two codes for the first position and a list of one code for the second.
If the product is traveling in several boxes, the labeling code must be transmitted for each of them.
{% note warning "Если вы работаете по модели FBS, EXPRESS" %}
For orders that contain jewelry or products marked in the system «Честный ЗНАК», conversion to the status `READY_TO_SHIP` becomes available only when:
1. You will transfer it to Yandex.Market УИНы for each piece of jewelry in the order and the codes in the system «Честный ЗНАК» for all products in the order that require this marking.
2. All marking codes will be successfully verified. [How to get verification statuses](https://yandex.ru/dev/market/partner-api/doc/en/reference/orders/getOrderIdentifiersStatus.md)
{% endnote %}
{% endcut %}
{% cut "Как удалить товар из заказа" %}
To remove an item from an order:
1. Add to the request `allowRemove: true`.
2. Transfer the distribution to boxes without the item to be removed.
{% note warning "Удаление нельзя отменить" %}
This operation is irreversible: the buyer will immediately receive a notification, and the order composition will change.
{% endnote %}
To delete an entire position, do not pass the corresponding `OrderBoxLayoutItemDTO`. To reduce the quantity of the product, pass the reduced value in the field `fullCount`.
You cannot delete or reduce the quantity of an item if it:
* added by special offer;
* amounts to 99% of the order value;
* the only product in the order.
If you cannot ship such an item, cancel the order. To do this, send a request using the method [PUT v2/campaigns/{campaignId}/orders/{orderId}/status](https://yandex.ru/dev/market/partner-api/doc/en/reference/orders/updateOrderStatus.md) and send the order status `CANCELLED` with the reason for cancellation `SHOP_FAILED`.
{% endcut %}
{% note info "Увеличить заказ нельзя" %}
You cannot use a query to increase the number of identical items, add new items to an order, or replace one item with another.
{% endnote %}
## Examples
{% cut "Товар умещается в коробку" %}
This is what the request will look like if they are traveling in the same box:
* three units of the same product that require labeling;
* one unit of another product that does not require labeling.
```json translate=no
{
"boxes": [
{
"items": [
{
"id": 123456,
"fullCount": 3,
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
},
{
"cis": "010304109478gftJ14545762!\u001dhGt264"
},
{
"cis": "010304109478fRs28323ks23!\u001dhet201"
}
]
},
{
"id": 654321,
"fullCount": 1
}
]
}
]
}
```
{% endcut %}
{% cut "Товар едет в разных коробках" %}
This is what the request will look like if the product comes in two boxes:
```json translate=no
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
```
{% endcut %}
{% cut "Одинаковые товары, где каждый едет в нескольких коробках" %}
This is what the request will look like if each of the two identical products travels in two boxes:
```json translate=no
{
"boxes": [
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
},
{
"items": [
{
"id": 123456,
"partialCount": {
"current": 2,
"total": 2
},
"instances": [
{
"cis": "01030410947874432155Qbag!\u001d93Zjqw"
}
]
}
]
}
]
}
```
{% endcut %}
{% cut "Разные товары в разных коробках" %}
This is what the request will look like if two different products are placed in different boxes:
```json translate=no
{
"boxes": [
{
"items": [
{
"id": 123456,
"fullCount": 1
}
]
},
{
"items": [
{
"id": 654321,
"fullCount": 1
}
]
}
]
}
```
{% endcut %}
|
**⚙️ Limit:** 10 000 requests per hour
|
|-|
## Request
PUT {.openapi__method}
```text translate=no
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/boxes
```
### Path parameters
#|
|| **Name** | **Description** ||
||
_campaignId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query [GET v2/campaigns](https://yandex.ru/dev/market/partner-api/doc/en/reference/campaigns/getCampaigns.md) or find it in the seller's office on the Market. Click on your account icon → **Settings** and in the menu on the left, select **APIs and modules**:
* block **Campaign ID**;
* tab **Query log** → drop-down list in the block **Show logs**.
⚠️ Do not confuse it with:
- the store's identifier, which is displayed in the merchant's personal account.
- advertising campaigns.
_Min value:_{.json-schema-reset .json-schema-assertion} `1`
{.table-cell}
||
||
_orderId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
The order ID.
{.table-cell}
||
|#{.json-schema-properties}
### Body
{% cut "application/json" %}
```json translate=no
{
"boxes": [
{
"items": [
{
"id": 0,
"fullCount": 1,
"partialCount": {},
"instances": [
null
]
}
]
}
],
"allowRemove": false
}
```
{% endcut %}
#|
|| **Name** | **Description** ||
||
_boxes_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**Type**: object[]" %}
#|
||
_items_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**Type**: object[]" %}
#|
||
_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
The product ID in the order.
It comes in the response of the method [POST v1/businesses/{businessId}/orders](https://yandex.ru/dev/market/partner-api/doc/en/reference/orders/getBusinessOrders.md) — parameter `id` in `items`.
{.table-cell}
||
||
_fullCount_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer
The number of items in a box.
Use this field if there are whole items in the box that are not divided into parts. Do not use this field at the same time as `partialCount`.
_Min value:_{.json-schema-reset .json-schema-assertion} `1`
{.table-cell}
||
||
_instances_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object[]" %}
#|
||
_cis_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
[Identification code](*cis-regular-value) product units in the system ["An honest SIGN"](https://честныйзнак.рф/) or [«ASL BELGISI»](https://aslbelgisi.uz) (for sellers of the Yandex Go Market).
{% note warning "Не экранируйте косую черту в коде символа-разделителя `\u001d`" %}
✅ `01030410947874432155Qbag!\u001d93Zjqw`
❌ `01030410947874432155Qbag!\\u001d93Zjqw`
Escape slashes and quotation marks in other places according to the JSON rules.: `\\` and `\"`
{% endnote %}
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||
_countryCode_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
The country of manufacture is in the ISO 3166-1 alpha-2 format. [How to get](https://yandex.ru/dev/market/partner-api/doc/en/reference/regions/getRegionsCodes.md)
_Min length:_{.json-schema-reset .json-schema-assertion} `2`
_Max length:_{.json-schema-reset .json-schema-assertion} `2`
_Pattern:_{.json-schema-reset .json-schema-assertion} `^[A-Z]{2}$`
_Example:_{.json-schema-reset .json-schema-example} `RU`
{.table-cell}
||
||
_gtd_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
Cargo customs declaration.
It is a string of three numbers separated by a slash: XXXXXXXXXX/XXXXXXXX/XXXXXXXX.
The first part — the code of the customs office that registered the declaration for imported goods. Further — date and number of the declaration.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||
_rnpt_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
The registration number of the product batch.
It is a string of four numbers separated by slashes: XXXXXXXXXX/XXXXXXXX/XXXXXXXX/XXX.
The first part — the code of the customs office that registered the declaration for the shipment. Further — the date, number of the declaration and the number of the marked product in the declaration.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||
_uin_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
The unique identification number of the jewelry.
It is a 16-digit number.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
Transmitted marking codes.
_Min items:_{.json-schema-reset .json-schema-assertion} `1`
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"cis": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
]
```
{% endcut %}
{.table-cell}
||
||
_partialCount_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}
#|
||
_current_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
The part number, starting from 1.
_Min value:_{.json-schema-reset .json-schema-assertion} `1`
{.table-cell}
||
||
_total_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
The total number of parts the product is divided into.
_Min value:_{.json-schema-reset .json-schema-assertion} `2`
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
Information about the part of the product in the box.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"current": 1,
"total": 2
}
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
The list of products in the box.
If there is a part of a large product in the box, there can be only one item in the list.
_Min items:_{.json-schema-reset .json-schema-assertion} `1`
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"id": 0,
"fullCount": 1,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{
"cis": "example",
"uin": "example",
"rnpt": "example",
"gtd": "example",
"countryCode": "RU"
}
]
}
]
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
A list of boxes.
_Min items:_{.json-schema-reset .json-schema-assertion} `1`
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"items": [
{
"id": 0,
"fullCount": 1,
"partialCount": {
"current": 1,
"total": 2
},
"instances": [
{}
]
}
]
}
]
```
{% endcut %}
{.table-cell}
||
||
_allowRemove_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean
Pass it on `true` if you are going to remove some of the items from the order.
_Default:_{.json-schema-reset .json-schema-value} `false`
{.table-cell}
||
|#{.json-schema-properties}
## Responses
## 200 OK
In response, you will receive the transmitted layout with the box IDs. — you will need them to request shortcuts.
### Body
{% cut "application/json" %}
```json translate=no
{
"status": "OK",
"result": {
"boxes": [
{}
]
}
}
```
{% endcut %}
**Type**: object
{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
- {% cut "**Type**: object" %}
#|
||
_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The type of response.
Possible values:
* `OK` — There are no errors.
* `ERROR` — an error occurred while processing the request.
_Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
The standard wrapper for server responses.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK"
}
```
{% endcut %}
- {% cut "**Type**: object" %}
#|
||
_result_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}
#|
||
_boxes_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: object[]
A list of boxes.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"items": [
{
"id": 0,
"fullCount": 1,
"partialCount": {},
"instances": [
null
]
}
],
"boxId": 0
}
]
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
Distribution of goods by boxes.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"boxes": [
{
"items": [
{}
],
"boxId": 0
}
]
}
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"result": {
"boxes": [
{
"items": [
null
],
"boxId": 0
}
]
}
}
```
{% endcut %}
{% endcut %}
## 400 Bad Request
The request contains incorrect data. [Learn more about errors when working with orders](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#orders)
### Body
{% cut "application/json" %}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
**Type**: object
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
#|
||
_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The type of response.
Possible values:
* `OK` — There are no errors.
* `ERROR` — an error occurred while processing the request.
_Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
{.table-cell}
||
|#{.json-schema-properties}
The standard wrapper for server responses.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK"
}
```
{% endcut %}
- **Type**: object
#|
||
_errors_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object[]" %}
#|
||
_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The error code.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||
_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
Description of the error.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
A list of errors.
_Min items:_{.json-schema-reset .json-schema-assertion} `1`
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"code": "example",
"message": "example"
}
]
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
A standard wrapper for server errors.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
## 401 Unauthorized
The authorization data is not specified in the request. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#401)
### Body
{% cut "application/json" %}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
**Type**: object
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
#|
||
_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The type of response.
Possible values:
* `OK` — There are no errors.
* `ERROR` — an error occurred while processing the request.
_Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
{.table-cell}
||
|#{.json-schema-properties}
The standard wrapper for server responses.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK"
}
```
{% endcut %}
- **Type**: object
#|
||
_errors_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object[]" %}
#|
||
_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The error code.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||
_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
Description of the error.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
A list of errors.
_Min items:_{.json-schema-reset .json-schema-assertion} `1`
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"code": "example",
"message": "example"
}
]
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
A standard wrapper for server errors.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
## 403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#403)
### Body
{% cut "application/json" %}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
**Type**: object
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
#|
||
_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The type of response.
Possible values:
* `OK` — There are no errors.
* `ERROR` — an error occurred while processing the request.
_Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
{.table-cell}
||
|#{.json-schema-properties}
The standard wrapper for server responses.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK"
}
```
{% endcut %}
- **Type**: object
#|
||
_errors_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object[]" %}
#|
||
_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The error code.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||
_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
Description of the error.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
A list of errors.
_Min items:_{.json-schema-reset .json-schema-assertion} `1`
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"code": "example",
"message": "example"
}
]
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
A standard wrapper for server errors.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
## 404 Not Found
The requested resource was not found. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#404)
### Body
{% cut "application/json" %}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
**Type**: object
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
#|
||
_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The type of response.
Possible values:
* `OK` — There are no errors.
* `ERROR` — an error occurred while processing the request.
_Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
{.table-cell}
||
|#{.json-schema-properties}
The standard wrapper for server responses.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK"
}
```
{% endcut %}
- **Type**: object
#|
||
_errors_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object[]" %}
#|
||
_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The error code.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||
_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
Description of the error.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
A list of errors.
_Min items:_{.json-schema-reset .json-schema-assertion} `1`
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"code": "example",
"message": "example"
}
]
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
A standard wrapper for server errors.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
## 420 Method Failure
The resource access limit has been exceeded. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#420)
### Body
{% cut "application/json" %}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
**Type**: object
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
#|
||
_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The type of response.
Possible values:
* `OK` — There are no errors.
* `ERROR` — an error occurred while processing the request.
_Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
{.table-cell}
||
|#{.json-schema-properties}
The standard wrapper for server responses.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK"
}
```
{% endcut %}
- **Type**: object
#|
||
_errors_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object[]" %}
#|
||
_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The error code.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||
_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
Description of the error.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
A list of errors.
_Min items:_{.json-schema-reset .json-schema-assertion} `1`
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"code": "example",
"message": "example"
}
]
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
A standard wrapper for server errors.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
## 500 Internal Server Error
Internal error of the Market. [More information about the error](https://yandex.ru/dev/market/partner-api/doc/en/concepts/error-codes.md#500)
### Body
{% cut "application/json" %}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
**Type**: object
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
{% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
- **Type**: object
#|
||
_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The type of response.
Possible values:
* `OK` — There are no errors.
* `ERROR` — an error occurred while processing the request.
_Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
{.table-cell}
||
|#{.json-schema-properties}
The standard wrapper for server responses.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK"
}
```
{% endcut %}
- **Type**: object
#|
||
_errors_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object[]" %}
#|
||
_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string
The error code.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||
_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string
Description of the error.
_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}
{% endcut %}
A list of errors.
_Min items:_{.json-schema-reset .json-schema-assertion} `1`
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
[
{
"code": "example",
"message": "example"
}
]
```
{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
A standard wrapper for server errors.
{% cut "**Example**" %}{.json-schema-example}
```json translate=no
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
```
{% endcut %}
{% endcut %}
- Console
```openapi-sandbox translate=no
pathParams:
- description: "The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) or find it in the seller's office on the Market. Click on your account icon → **Settings** and in the menu on the left, select **APIs and modules**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
name: campaignId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
- description: The order ID.
name: orderId
in: path
required: true
schema:
type: integer
format: int64
searchParams: []
headers: []
body: |-
{
"boxes": [
{
"items": [
{
"id": 0,
"fullCount": 1,
"partialCount": {},
"instances": [
null
]
}
]
}
],
"allowRemove": false
}
schema:
type: object
required:
- boxes
properties:
boxes:
description: A list of boxes.
type: array
minItems: 1
items:
description: Information about the box.
type: object
required:
- items
properties:
items:
description: >
The list of products in the box.
If there is a part of a large product in the box, there can be
only one item in the list.
type: array
minItems: 1
items:
description: Information about the product in the box.
type: object
required:
- id
properties:
id:
description: "The product ID in the order.\n\nIt comes in the response of the method [POST\_v1/businesses/{businessId}/orders](../../reference/orders/getBusinessOrders.md) — parameter `id` in `items`.\n"
type: integer
format: int64
fullCount:
description: >
The number of items in a box.
Use this field if there are whole items in the box that are
not divided into parts. Do not use this field at the same
time as `partialCount`.
type: integer
format: int32
minimum: 1
partialCount:
description: Information about the part of the product in the box.
type: object
required:
- current
- total
properties:
current:
description: The part number, starting from 1.
type: integer
format: int32
minimum: 1
total:
description: The total number of parts the product is divided into.
type: integer
format: int32
minimum: 2
instances:
description: Transmitted marking codes.
type: array
nullable: true
minItems: 1
items:
description: >
Product unit ID.
Fill in only one field, depending on which system the
product is labeled in.
Read more about working with labeled products. [in the
Help of the Market for
sellers](https://yandex.ru/support/marketplace/orders/cz.html).
type: object
properties:
cis:
description: >+
[Identification
code](*cis-regular-value) product units
in the system ["An honest
SIGN"](https://честныйзнак.рф/) or
[«ASL BELGISI»](https://aslbelgisi.uz)
(for sellers of the Yandex Go Market).
{% note warning "Не экранируйте косую черту в коде
символа-разделителя `\u001d`" %}
✅ `01030410947874432155Qbag!\u001d93Zjqw`
❌ `01030410947874432155Qbag!\\u001d93Zjqw`
Escape slashes and quotation marks in other places
according to the JSON rules.: `\\` and `\"`
{% endnote %}
type: string
uin:
description: |
The unique identification number of the jewelry.
It is a 16-digit number.
type: string
rnpt:
description: >
The registration number of the product batch.
It is a string of four numbers separated by slashes:
XXXXXXXXXX/XXXXXXXX/XXXXXXXX/XXX.
The first part — the code of the
customs office that registered the declaration for the
shipment. Further — the date, number of
the declaration and the number of the marked product
in the declaration.
type: string
gtd:
description: >
Cargo customs declaration.
It is a string of three numbers separated by a slash:
XXXXXXXXXX/XXXXXXXX/XXXXXXXX.
The first part — the code of the
customs office that registered the declaration for
imported goods. Further — date and
number of the declaration.
type: string
countryCode:
description: >
The country of manufacture is in the ISO 3166-1
alpha-2 format. [How to
get](../../reference/regions/getRegionsCodes.md)
type: string
minLength: 2
maxLength: 2
pattern: ^[A-Z]{2}$
example: RU
allowRemove:
description: >-
Pass it on `true` if you are going to remove some of the
items from the order.
type: boolean
default: false
bodyType: application/json
method: put
security:
- type: apiKey
name: 'Api-Key'
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/campaigns/{campaignId}/orders/{orderId}/boxes
host: https://api.partner.market.yandex.ru
```
{% endlist %}