Transfer of unit marking codes

Info

Console

The method is available for the DBS model.

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
all-methods — Full account management

If you work according to the FBS model

Use the method PUT campaigns/{campaignId}/orders/{orderId}/boxes.

Transmits the labeling codes for the product units in the specified order to the Market.

Labeling of goods in the system "An honest SIGN" optional for orders from individuals, but required for business orders.

The following types of codes are accepted:

Codes in the system "An honest SIGN" or «ASL BELGISI» (for sellers of the Yandex Go Market).
WIN for jewelry.
RNPT and GTD for imported traceable goods.

Before working with this method

Be sure to read it an article about working with labeled goods.

For each item in the order that requires labeling, you need to send 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.

, Limit: 100,000 requests per hour

Request

PUT

https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/identifiers

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:

Modules and APIs → block Sending data to Yandex.Market.
Query log → drop-down list in the block Show logs.

, Do not send the store's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports.

Min value: 1

orderId*

Type: integer<int64>

The order ID.

Body

application/json

{
    "items": [
        {
            "id": 0,
            "instances": [
                {
                    "cis": "string",
                    "uin": "string",
                    "rnpt": "string",
                    "gtd": "string",
                    "countryCode": "RU"
                }
            ]
        }
    ]
}

Name

Description

items*

Type: OrderItemInstanceModificationDTO[]

A list of items that require labeling.
An item in the shopping cart that requires labeling.

OrderItemInstanceModificationDTO

An item in the shopping cart that requires labeling.

Name

Description

id*

Type: integer<int64>

The product ID in the order.

It comes in response to a request GET campaigns/{campaignId}/orders/{orderId} — parameter id in items.

instances*

Type: BriefOrderItemInstanceDTO[]

A list of item labeling codes.
Product unit ID.

Fill in only one field, depending on which system the product is labeled in.

Detailed information about working with labeled goods is provided in the Help of the Market for sellers.

BriefOrderItemInstanceDTO

Product unit ID.

Fill in only one field, depending on which system the product is labeled in.

Detailed information about working with labeled goods is provided in the Help of the Market for sellers.

Name	Description
cis	Type: string The unit identification code in the system "An honest SIGN" or «ASL BELGISI» (for sellers of the Yandex Go Market). Do not escape the slash in the separator character code. `\u001d` ✅ `01030410947874432155Qbag!\u001d93Zjqw` ❌ `01030410947874432155Qbag!\\u001d93Zjqw` Escape slashes and quotation marks in other places according to the JSON rules.: `\\` and `\"`
countryCode	Type: string The country of manufacture is in the ISO 3166-1 alpha-2 format. How to get Example: `RU` Min length: `2` Max length: `2` Pattern: `^[A-Z]{2}$`
gtd	Type: string Cargo customs declaration. It is a string of three numbers separated by a slash: XXXXXXXXXX/XXXXXXXX/XXXXXXXX. The first part is the code of the customs office that registered the declaration for imported goods. Next is the date and number of the declaration.
rnpt	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 is the code of the customs office that registered the declaration for the shipment. Next is the date, the number of the declaration and the number of the marked product in the declaration.
uin	Type: string The unique identification number of the jewelry. It is a 16-digit number.

Responses

200 OK

Answer 200 indicates that the codes were successfully recorded. The response contains brief information about the marked products.

Body

application/json

{
    "status": "OK",
    "result": {
        "items": [
            {
                "id": 0,
                "vat": "NO_VAT",
                "count": 0,
                "price": 0,
                "offerName": "string",
                "offerId": "string",
                "instances": [
                    {
                        "cis": "string",
                        "cisFull": "string",
                        "uin": "string",
                        "rnpt": "string",
                        "gtd": "string",
                        "countryCode": "RU"
                    }
                ]
            }
        ]
    }
}

Name

Description

result

Type: OrderItemsModificationResultDTO

Brief information about the marked goods. The parameter is returned if the response is OK.

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

OrderItemsModificationResultDTO

Brief information about the marked goods. The parameter is returned if the response is OK.

Name

Description

items*

Type: BriefOrderItemDTO[]

The list of items in the order to be marked.
Information about the labeled product.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

BriefOrderItemDTO

Information about the labeled product.

Name	Description
count	Type: integer<int32> The number of product units.
id	Type: integer<int64> The product ID in the order. Allows you to identify the product within the scope of this order.
instances	Type: OrderItemInstanceDTO[] The marking codes you provided. The marking or fault codes you have provided for this position. The "Honest Sign" codes are returned in two versions — with and without a cryptotail. Min items: `1`
offerId	Type: string Your product ID. Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`
offerName	Type: string Product name.
price	Type: number The price of the product. It is specified in the currency that was specified in the catalog. The separator of the whole and fractional parts is a dot.
vat	Type: OrderVatType Value added tax (VAT) on the product: `NO_VAT` — VAT is not charged, it is used only for certain types of services. `VAT_0` — 0% VAT. For example, it is used for the sale of goods exported in the customs procedure of export, or for the provision of services for the international transportation of goods. `VAT_10` — 10% VAT. For example, it is used in the sale of certain food and medical products. `VAT_10_110` — VAT 10/110. 10% VAT, applicable only for prepayment. `VAT_20` — 20% VAT. Basic VAT starting in 2019. `VAT_20_120` — VAT 20/120. VAT is 20%, applicable only for prepayment. `VAT_18` — VAT 18%. Basic VAT until 2019. `VAT_18_118` — VAT 18/118. VAT was used until January 1, 2019 for prepayment. `VAT_12` — 12% VAT. It is used only in Uzbekistan. `VAT_05` — 5% VAT. VAT for the simplified taxation system (USN). `VAT_07` — 7% VAT. VAT for the simplified taxation system (USN). `UNKNOWN_VALUE` — unknown type. Used only in conjunction with the parameter `payment-method=YANDEX`. Enum: `NO_VAT`, `VAT_0`, `VAT_10`, `VAT_10_110`, `VAT_20`, `VAT_20_120`, `VAT_18`, `VAT_18_118`, `VAT_12`, `VAT_05`, `VAT_07`, `UNKNOWN_VALUE`

OrderItemInstanceDTO

The marking or fault codes you have provided for this position. The "Honest Sign" codes are returned in two versions — with and without a cryptotail.

Name	Description
cis	Type: string The unit identification code in the system "An honest SIGN" without a cryptotail or «ASL BELGISI» (for sellers of the Yandex Go Market).
cisFull	Type: string The unit identification code in the system "An honest SIGN" with a cryptotail.
countryCode	Type: string The country of manufacture is in the ISO 3166-1 alpha-2 format. How to get Example: `RU` Min length: `2` Max length: `2` Pattern: `^[A-Z]{2}$`
gtd	Type: string Cargo customs declaration. It is a string of three numbers separated by a slash: XXXXXXXXXX/XXXXXXXX/XXXXXXXX. The first part is the code of the customs office that registered the declaration for imported goods. Next is the date and number of the declaration.
rnpt	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 is the code of the customs office that registered the declaration for the shipment. Next is the date, the number of the declaration and the number of the marked product in the declaration.
uin	Type: string Jewelry's UIN (16-digit code) The manufacturer receives the UIN when he registers the product in the system of control over the turnover of precious metals and stones — GIIS DMDK.

OrderVatType

Value added tax (VAT) on the product:

NO_VAT — VAT is not charged, it is used only for certain types of services.
VAT_0 — 0% VAT. For example, it is used for the sale of goods exported in the customs procedure of export, or for the provision of services for the international transportation of goods.
VAT_10 — 10% VAT. For example, it is used in the sale of certain food and medical products.
VAT_10_110 — VAT 10/110. 10% VAT, applicable only for prepayment.
VAT_20 — 20% VAT. Basic VAT starting in 2019.
VAT_20_120 — VAT 20/120. VAT is 20%, applicable only for prepayment.
VAT_18 — VAT 18%. Basic VAT until 2019.
VAT_18_118 — VAT 18/118. VAT was used until January 1, 2019 for prepayment.
VAT_12 — 12% VAT. It is used only in Uzbekistan.
VAT_05 — 5% VAT. VAT for the simplified taxation system (USN).
VAT_07 — 7% VAT. VAT for the simplified taxation system (USN).
UNKNOWN_VALUE — unknown type.

Used only in conjunction with the parameter payment-method=YANDEX.

Type	Description
OrderVatType	Enum: `NO_VAT`, `VAT_0`, `VAT_10`, `VAT_10_110`, `VAT_20`, `VAT_20_120`, `VAT_18`, `VAT_18_118`, `VAT_12`, `VAT_05`, `VAT_07`, `UNKNOWN_VALUE`

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Massive changes in order statuses