Item Management (items)

Returns the list of all item parent categories

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

Returns list of the subcategory 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 returns list of brands by subcategory ID.

The method allows to get separately free and paid vendor limits for creating listings.
To calculate the number of items that can be listed, use the formula: (freeLimits + paidLimits) - Number of listed items.
All items that can be obtained using the listings and listings that are in the trash methods are considered listed.

Generates array of unique SKUs to list size of the item

Lists items. You can specify item description and characteristics.

How to list an item:

1. Get parent categories list
2. Get the category and get all subcategories
3. Choose the subcategory 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 item was not listed, check errors using failed listing with errors method.

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

With one request you can list maximum 100 individual items or 100 groups of merged listings, 30 listings (nmID) in each. Maximum request size is 10 Mb.

Items are listed asynchronously. The process of synchronizing a new listing with services may take up to 30 minutes. During this time, you can't add inventory to warehouses and set prices.

In the sandbox, the product card is created immediately, without waiting.

The method lists items by merging it with existing individual listings and groups of merged listings. There can be no more than 30 listings in one group of merged listings, respectively, you can list no more than 29 items in one request.

The dimensions of the items can only be specified in centimeters, and the weight of packed items must be specified in kilograms.
If this method response is Success (200) but listing was not updated, check errors using failed listings with errors method.
Items are listed asynchronously. The process of synchronizing a new listing with services may take up to 30 minutes. During this time, you can't add inventory to warehouses and set prices.

In the sandbox, the product card is created immediately, without waiting.

Returns the listings.

To get more than 100 listings, use pagination:

1. Make the first request:

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

   To get only new or updated listings after data export, use ascending sorting: "sort":{"ascending":true}.
2. Copy "updatedAt": "***","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 listings.

To get only items that were listed or updated after the previous data export:

1. Save the "cursor":{"updatedAt":"***","nmID":"***"} fields from the last response of the previous data export. When exporting the data, use ascending sorting: "sort":{"ascending":true}.
2. Specify the saved "cursor":{"updatedAt":"***","nmID":"***"} fields in the first request. Keep using ascending sorting.
3. Save the "cursor":{"updatedAt":"***","nmID":"***"} fields from the last response of the current data export.

Returns the listings (drafts) and the list of errors encountered during listing creation or editing.

The data is returned in batches. One batch contains:

• all errors for one variants array in one request during listings creation
• all errors in one request during listings 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 listings. Also use it to add new sizes.

You cannot use this method to update or delete:

• item size SKUs. You can only add additional SKUs
• the photos, video and tags parameters
• prices of items. The price can only be set if you add new sizes

When adding a new size, specify its price using the price parameter. If no price is specified in the request, the size price will be 0. In this case, you can update it using the methods:

• Set Prices and Discounts, if item has "editablePriceSize":false
• Set Size Prices, if item has "editablePriceSize":true

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

If this method response is Success (200) but listing was not updated, check errors using failed listings with errors method.
With one request you can edit maximum 3000 listings (nmID). Maximum request size is 10 Mb.
The process of synchronizing data with services may take up to 30 minutes. During this time, you can't add inventory to warehouses and set prices.

The method merges and separates listings. Listings are merged if they have the same imtID.

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

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

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

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

The maximum request size is 10 MB.

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

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

A listing will remain for sale as long as there is any inventory left, even if moved to the trash. To completely remove the listing from sale, set its inventory to zero.

Returns the listing from trash

Returns the listings in trash.

To get more than 100 listings, use pagination.

1. Make the first request:
   

      {
        "settings": {
          "sort": {
            "ascending": true
          },
          "cursor": {
            "limit": 100
          }
        }
      }

   To get only listings that were transferred to the trash after data export, use ascending sorting: "sort":{"ascending":true}.
2. Copy "trashedAt":"***","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 listings.

To get only listings that were transferred to the trash after the previous data export:

1. Save "trashedAt":"***","nmID":*** from the cursor of the previous data export. When data export, use ascending sorting: "sort":{"ascending":true}.
2. Specify the "cursor":{"trashedAt":"***","nmID":"***"} saved fields in the first request. Keep using ascending sorting.
3. Save the "cursor":{"trashedAt":"***","nmID":"***"} fields from the last response of the current data export.

Uploads and adds one media file for the listing.

Requirements for images:

• maximum images for each listing  — 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 listing
• maximum size — 50 MB
• formats — MOV, MP4