Seller API Content

Creating a card is asynchronous, after sending the request is put in a queue for processing.

A product card is valid if at least one nomenclature has been created successfully.

Important. If there were errors during queue processing, the nomenclature is considered invalid.

How to create a card:

1. Get parent categories using Parent categories method.
2. Choose the category and get all subcategories using Product categories list.
3. Choose the subcategory and get all available characteristics using characteristics methods. Use values from Configurator to get values of color, gender, country of origin, season and HS code.
4. Send the request. If the response is Success (200) but the card was not created, check errors using List of failed nomenclature with errors method.

With one request you can create maximum 100 cards (imtID) and 30 nomenclatures (nmID) in each card. Maximum request size is 10 Mb.

The dimensions of the goods can only be specified in centimeters.

Edits product cards. If you need some product data, get it using Nomenclature list method.

You can not edit or delete barcodes but you can add new ones. You have not to send photos, video and tags and can not edit them.

If this method response is Success (200) but product card was not updated, check errors using List of failed nomenclature with errors method. Correct the request and try again.

With one request you can edit maximum 3000 nomenclatures (nmID). Maximum request size is 10 Mb.

The dimensions of the goods can only be specified in centimeters.

Adds new nomenclature to the product card.
Adding nomenclature is asynchronous, after sending the request is put in a queue for processing.
Important. If the adding request passed but the nomenclature was not created, check errors using List of failed nomenclature with errors method. If the nomenclature is listed there, you should correct the reported errors in the adding nomenclature request and resend it.
Maximum request size is 10 Mb.

The dimensions of the goods can only be specified in centimeters.

Merges nomenclatures (nmID) in same product card (imtID) or separate them.

To merge nomenclatures, the request with a list of nomenclatures has to be sent with the targetIMT parameter specified in the body of the request. In this case, all nomenclatures will be merged under the imtID specified in the targetIMT.

To separate the nomenclature from the product card, it is necessary to pass this nomenclature without the targetIMT parameter in the request body.
This creates a new imtID for the transferred nomenclature.
If several nomenclatures are passed in the separating request, they will all be automatically merged under one new imtID.
To assign a unique imtID to each nomenclature, it is necessary to send one nomenclature per query. For nomenclatures that are not transferred in the request, no changes will be made.
Maximum request size is 10 Mb.

Important. It is possible to merge nomenclatures containing only the same items.
Important. One product card (inside one imtID) cannot contain more than 30 nomenclatures (nmID).

Generates array of unique barcodes to create size of nomenclature in product card.

Method provides list of created nomenclatures with different filters, pagination and sorting.

This method is available by token with the option Promotion

Important. Nomenclatures in the trash, will not issue in the response of method.
You can get such nomenclatures using by method "List of nomenclatures that are in the trash"

How to work with cursor/list:
To get full list of nomenclatures, if their number exceed 100, user need to use pagination.

1. Make first request (all listed params are required):

           {
             "settings": {
               "cursor": {
                 "limit": 100
               },
               "filter": {
                 "withPhoto": -1
               }
             }
           }

   
   In addition you can add "textSearch" and sort.

           "sort": {
             "sortColumn": "",
             "ascending": false
           }

2. From last part of response list, copy 2 strings from cursor field response:
   • "updatedAt": "***",
   • "nmID": ***,
3. Paste copied strings in new request.
4. Repeat 2 and 3, until total will be less than limit in response.
   This will mean you got all cards.

Method allows to get list of nomenclature's and list of errors happened during creation of product card.
Warning: to delete nomenclature from failed you need to repeat request with corrected errors of creation product card.

The method allows to get separately free and paid vendor limits for creating product cards.
To calculate the number of cards that can be created, use the formula: (freeLimits + paidLimits) - Number of cards created.
All cards that can be obtained using the "Nomenclature list" and "List of nomenclatures that are in the trash" methods are considered created.

Method provides list of all parent categories of products.

Using this method, you can get a list of product categories by a text filter (category name).

To get a list of all categories, you need to specify “top” parameter bigger than available quantity of categories (eg top=8000)

As of 03/27/2023, there are 7440 categories in the list. The number of available categories may change.

Returns list of the subject characteristics by its ID

Provides values of color characteristic.

Provides values of sex characteristic.

Provides value of characteristic country of origin.

Provide values of season characteristic.

Method provides list of HS codes by category name and filter by HS code.

Using this method, you can obtain a list of values for the VAT rate characteristic

Edits product (nomenclature) media files.

Attention. New media files (data) replace old ones (mediaFiles). To add new files, set links both to new and old files.

Requirements to images:

• maximum images for each product (nomenclature) — 30,
• minimal resolution – 700 × 900 pixels,
• maximum size — 32 MB,
• minimal quality — 65%,
• formats — JPG, PNG, BMP, GIF (static), WebP.

Requirements video:

• maximum video for each product (nomenclature),
• maximum size — 50 MB,
• formats — MOV, MP4.

If one or several images do not meet the requirements, no images will be uploaded even if you have the success response (200).

Adds one media file for the product (nomenclature).

Requirements to images:

• maximum images for each product (nomenclature) — 30,
• minimal resolution – 700 × 900 pixels,
• maximum size — 32 МB,
• minimal quality — 65%,
• formats — JPG, PNG, BMP, GIF (static), WebP.

Requirements video:

• maximum video for each product (nomenclature),
• maximum size — 50 MB;
• formats — MOV, MP4.

The method allows to get a list of existing seller's tags.

The method allows you to create a tag.
It is possible to create 15 tags.
The maximum length of a tag is 15 characters.

The method allows to change the information about the tag (name and color).

The method allows to remove the tag.

The method allows to add tags to the product card and remove tags from the product card.
When removing a tag from a product card, the tag itself is not removed.
It is possible to add 15 tags to a product card.

Moves the nomenclature into trash for 30 days. After 30 days this nomenclature will be deleted

Returns the nomenclature from trash IMPORTANT: When restoring the nomenclature from the trash, its imtID doesn't remain the same as it was for the item in the trash.

Method provides list of nomenclatures in trash.

This method is available by token with the option Promotion


Workflow:
To get full list of nomenclatures, if their number exceed 100, user need to use pagination.

1. Make the first request (all listed parameters are required):
   

           {
             "settings": {
               "cursor": {
                 "limit": 100
               }
             }
           }

   
   
2. From last part of response list copy 2 strings from cursor field response:
   • "trashedAt": "***",
   • "nmID": ***,
3. Paste copied strings in cursor request parameter, repeat the method request.
4. Repeat 2 and 3, until total will be less than limit in response.
   This will mean you got all cards.