Product Management (products)

Returns the list of all products parent categories

Returns the list of all available subjects, subjects parent categories and their IDs

Returns list of the subject characteristics by its ID

Provides values of color characteristic.

Provides values of gender characteristic.

Provides value of characteristic country of origin.

Provide values of season characteristic

Returns a list of values for the VAT rate characteristic

The method provides list of HS-codes by category name and filter by HS-code.

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 product cards list and list of product cards that are in the trash methods are considered created.

Generates array of unique barcodes to create size of the product card

Creates products cards. You can specify product description and characteristics.

How to create a card:

1. Get parent categories list
2. Get the category and get all subjects
3. Choose the subject and get all available characteristics. For Color, Gender, Country of origin, Season, VAT rate, HS-code characteristics use values from category.
4. Send the request. If the response is Success (200) but the card was not created, check errors using list of failed product card with errors.

The dimensions of the products can only be specified in centimeters, and the weight of packed products must be specified in kilograms.

With one request you can create maximum 100 merged product cards (imtID), 30 product cards (nmID) in each. Maximum request size is 10 Mb.

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

The method creates new product cards by merging them with existing ones.

The dimensions of the products can only be specified in centimeters, and the weight of packed products must be specified in kilograms. Creating a card is asynchronous, after sending the request is put in a queue for processing. Maximum request size is 10 Mb.
If this method response is Success (200) but product card was not updated, check errors using list of failed nomenclature with errors.

Returns the list of created product cards.

To get more than 100 product cards, use pagination:

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

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

2. Copy "updatedAt": "***" and "nmID": *** from the cursor in the response and insert into the cursor of your next request.
3. Make the next request.
4. Repeat 2 and 3 until total value in the response is less than the limit value in the request. This will mean you got all cards.

Returns the list of product cards (drafts) and the list of errors encountered during product card creation or editing.

The data is returned in batches. One batch contains:

• all errors for one merged product card imtID in one request during product cards creation
• all errors in one request during product cards creation with merge or editing.
  
  To get more than 100 batches, use pagination:

1. Make first request:
   

      {
        "cursor": {
          "limit": 100
        },
        "order": {
          "ascending": true
        }
      }

2. Copy "updatedAt": "***","batchUUID": "***" from the response cursor and paste into the request cursor.
3. Repeat the request.
4. Repeat 2 and 3, until you receive in the response "next": false. This will mean that you have received all the batches.

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

The dimensions of the products can only be specified in centimeters, and the weight of packed products must be specified in kilograms.

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 product cards with errors.

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

The method merges and separates product cards. Product cards are considered merged if they have the same imtID.

To merge product cards, make a request specifying the imtID. You can merge up to 30 product cards at a time.

To separate product cards, make a request without specifying the imtID. New imtIDs will be generated for the separated cards.

If you separate multiple product cards simultaneously, these cards will merge into one and receive a new imtID.

To assign a unique imtID to each product card, you need to send one product card per request.

The maximum request size is 10 MB.

Transfers the product card to trash. In doing so, the product card would not be deleted.

After 30 days in the trash the product card would be deleted automatically. The trash is cleared every night according to Moscow time.
The product card can be deleted at any time in personal account.

Returns the product card from trash

Returns list of product cards in trash.

To get more than 100 product cards, use pagination.

1. Make the first request:
   

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

2. Copy "trashedAt": "***" and "nmID": *** from the cursor in the response and insert into the cursor of your next request.
3. Make the next request.
4. Repeat 2 and 3 until total value in the response is less than the limit value in the request. This will mean you got all cards.

Uploads and adds one media file for the product card.

Requirements for images:

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

Requirements for video:

• maximum one video for each product card
• maximum size — 50 MB
• formats — MOV, MP4

The method uploads a set of media files to a product card by specifying links in the request.

Requirements for links:

• the link must directly lead to the file. Ensure the link does not lead to a preview or authorization page. If the link leads to TXT or HTML page, it is considered incorrect
• no authorization is required to access the file via the link

Requirements for images:

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

Requirements for video:

• maximum one video for each product card
• maximum size — 50 MB
• formats — MOV, MP4

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

Returns seller's tags list

Creates a tag.

It is possible to create 15 tags.

The maximum length of a tag is 15 characters

Changes tag data: name and color

Deletes 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.