Transfer of "Fair Sign" codes
The method is available for models: FBS, Express and DBS.
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
Which method should I use instead of the outdated one?
Transmits the labeling codes for the products in the specified order to the Market.
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}/cis
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:
, Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.
Min value: |
|
orderId* |
Type: integer<int64> The order ID. |
Body
application/json
{
"items": [
{
"id": 0,
"instances": [
{
"cis": "string"
}
]
}
]
}
|
Name |
Description |
|
items* |
Type: OrderItemInstanceModificationCisDTO[] The actual list of items that require labeling.
|
OrderItemInstanceModificationCisDTO
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 |
|
instances* |
Type: BriefOrderItemInstanceCisDTO[] A list of item labeling codes.
|
BriefOrderItemInstanceCisDTO
Marking of a product unit.
|
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. ✅ ❌ Escape slashes and quotation marks in other places according to the JSON rules.: |
Responses
200 OK
A 200 response indicates that the marking codes have been 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"
}
]
}
]
}
}
|
Name |
Description |
|
result |
Type: OrderItemsModificationCisResultDTO Brief information about the marked goods. The parameter is returned if the response is |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
OrderItemsModificationCisResultDTO
Brief information about the marked goods. The parameter is returned if the response is OK.
|
Name |
Description |
|
items* |
Type: BriefOrderItemCisDTO[] The list of items in the order to be marked. |
ApiResponseStatusType
The type of response. Possible values:
OK— there are no mistakes.ERROR— an error occurred while processing the request.
|
Type |
Description |
|
Enum: |
BriefOrderItemCisDTO
Information about the marked 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: OrderItemInstanceCisDTO[] The marking codes you provided. Min items: |
|
offerId |
Type: string Your product ID. Min length: Max length: Pattern: |
|
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:
Used only in conjunction with the parameter Enum: |
OrderItemInstanceCisDTO
The marking codes you provided for this item. They come back 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. |
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 |
|
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error of the 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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.