Search

Product Management (products)

Manage content, prices and stocks

Product Management

Manage content, prices and stocks

Categories, Subjects and Characteristics

To access the methods, use a token for the Content category

Products parent categories{{ /content/v2/object/parent/all }}

Описание метода

Returns the list of all products parent categories

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Product name language (ru, en, zh)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Subjects list{{ /content/v2/object/all }}

Описание метода

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

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
name
string
Example: name=Socks

Search by product name (any supported language)

limit
integer
Example: limit=1000

Number of search results, maximum 1,000

locale
string
Example: locale=en

Response language (ru, en, zh)

offset
integer
Example: offset=5000

How many results to skip

parentID
integer
Example: parentID=1000

Parent category ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Subject characteristics (subcategories){{ /content/v2/object/charcs/{subjectId} }}

Описание метода

Returns list of the subject characteristics by its ID

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
subjectId
required
integer
Example: 105

ID предмета

query Parameters
locale
string
Example: locale=en

Language of subjectName and name (ru, en, zh)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Color{{ /content/v2/directory/colors }}

Описание метода

Provides values of color characteristic.

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Language of subjectName and name (ru, en, zh)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Gender{{ /content/v2/directory/kinds }}

Описание метода

Provides values of gender characteristic.

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Language of subjectName and name (ru, en, zh)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Country of origin{{ /content/v2/directory/countries }}

Описание метода

Provides value of characteristic country of origin.

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Language of subjectName and name (ru, en, zh)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Season{{ /content/v2/directory/seasons }}

Описание метода

Provide values of season characteristic

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Language of subjectName and name (ru, en, zh)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

HS codes{{ /content/v2/directory/tnved }}

Описание метода

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

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
subjectID
required
integer
Example: subjectID=105

Subject ID

search
integer
Example: search=6106903000

Search by HS code. Works only with the subjectID parameter

locale
string
Example: locale=en

Language (ru, en, zh) of the subjectName and name fields values. Not used in a sandbox

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

VAT rate{{ /content/v2/directory/vat }}

Описание метода

Returns a list of values for the VAT rate characteristic

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
required
string
Example: locale=ru

Language of the data elements values (ru, en, zh). Not used in the sandbox

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Products Cards

To access the methods, use a token for the Content category
Create and edit a product card.

Limits for the product cards{{ /content/v2/cards/limits }}

Описание метода

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.

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Upload cards{{ /content/v2/cards/upload }}

Описание метода

Creates products card. You can specify product description and characteristics in product card.
How to create a card:

  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 card was not created, check errors using list of failed nomenclature with errors.

The dimensions of the goods can only be specified in centimeters.
With one request you can create maximum 100 cards (imtID) and 30 nomenclatures (nmID) in each card. Maximum request size is 10 Mb.
Creating a card is asynchronous, after sending the request is put in a queue for processing.

If there were errors during queue processing, the nomenclature is considered invalid.
Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
Array
subjectID
required
integer

Subcategory ID

required
Array of objects

Product variants, maximum 30 in one card.

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Update cards{{ /content/v2/cards/update }}

Описание метода

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

The product card is overwritten during an update. Therefore, you need to include all parameters of the product card in the request, including those you do not intend to update.

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

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.

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

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
Array
nmID
required
integer

WB article

vendorCode
required
string

Supplier's article

brand
string

Brand

title
string

Product title

description
string

Product description. The maximum number of characters depends on the product category. Standard - 2000, minimum - 1000, maximum - 5000.
More details about description rules in Product card filling rules in Instructions category of sellers portal.

object

Product dimensions in centimeters

Array of objects

Product characteristics

required
Array of objects

Product sizes.
If product has no sizes, send only barcodes.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Adding nomenclature to the card{{ /content/v2/cards/upload/add }}

Описание метода

Adds new nomenclature to the product card. The dimensions of the goods can only be specified in centimeters. Adding nomenclature is asynchronous, after sending the request is put in a queue for processing. If the adding request passed but the nomenclature was not created, check errors using list of failed nomenclature with errors. Maximum request size is 10 Mb

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
imtID
integer

imtID of the card

Array of objects

Nomenclature

Responses

Request samples

Content type
application/json
{
  • "imtID": 987654321,
  • "cardsToAdd": [
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Merging or separating of nomenclatures{{ /content/v2/cards/moveNm }}

Описание метода

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. Maximum request size is 10 Mb

It is possible to merge nomenclatures containing only the same items.
Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
One of
targetIMT
required
integer

Seller's existing imtID, in which nomenclatures have to be merged

nmIDs
required
Array of integers

nmID to be merged, maximum 30

Responses

Request samples

Content type
application/json
Example
{
  • "targetIMT": 123,
  • "nmIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Generation of barcodes{{ /content/v2/barcodes }}

Описание метода

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

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
count
integer

Number of barcodes to be generated, maximum 5,000

Responses

Request samples

Content type
application/json
{
  • "count": 100
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Add media files{{ /content/v3/media/file }}

Описание метода

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
Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
header Parameters
X-Nm-Id
required
string
Example: 213864079

Wildberries article

X-Photo-Number
required
integer
Example: 2

Number of media file, starting from 1. To add the video set 1.

To add the image to the uploaded ones, set file the number more then number of uploaded files.

Request Body schema: multipart/form-data
required
uploadfile
string <binary>

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Edit media files{{ /content/v3/media/save }}

Описание метода

Edits product (nomenclature) media files.

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)

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmId
integer

Wildberries article

data
Array of strings

Links to images in the order that they are on the card

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json
{
  • "data": { },
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Nomenclatures

To access the methods, use a token for the Content category
Getting information about created product cards, nomenclatures and sizes.

Nomenclatures list{{ /content/v2/get/cards/list }}

Описание метода
Method is available with the token of the Promotion category

Returns the list of created nomenclatures.

To get more than 100 nomenclatures, you need to use pagination:

  1. Make first request (all listed params are required):
            {
              "settings": {                      
                "cursor": {
                  "limit": 100
                },
                "filter": {
                  "withPhoto": -1
                }
              }
            }
  2. From last part of response list, copy 2 strings from `cursor` field response:
    • "updatedAt": "***"
    • "nmID": ***
  3. Paste the copied strings to the request cursor, repeat the request.
  4. Repeat 2 and 3, until total will be less than limit in response. This will mean you got all cards.
Product cards from the trash are not provided in the method response. You can get these product cards via different method.
Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=ru

Language for response fields name, value and object translation: ru - Russian, en - English, zh - Chinese.

Is not used in the sandbox

Request Body schema: application/json
required
object

Settings

Responses

Request samples

Content type
application/json
{
  • "settings": {
    }
}

Response samples

Content type
application/json
{}

List of failed nomenclature with errors{{ /content/v2/cards/error/list }}

Описание метода

Returns the list of nomenclatures and the list of errors encountered during product card creation

To delete nomenclature from the errors list you need to repeat the product card creation request with fixed errors.
Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Example: locale=en

Language of multi-language parameters (for which the multi-language option is provided).

Is not used in the sandbox

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Transfer nomenclature to trash{{ /content/v2/cards/delete/trash }}

Описание метода

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

When transferring nomenclatures to the trash, this nomenclature is removed from the product card, meaning it is assigned a new imtID.
After 30 days in the trash the nomenclature would be deleted automatically. The trash is cleared every night according to Moscow time
Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array
nmIDs
Array of integers

WB article (max. 1000)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Recover nomenclature from trash{{ /content/v2/cards/recover }}

Описание метода

Returns the nomenclature from trash

When restoring the nomenclature from the trash, its imtID doesn't remain the same as it was for the nomenclature in the trash.
Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array
nmIDs
Array of arrays

WB article (max. 1000)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": { }
}

Nomenclatures in trash list{{ /content/v2/get/cards/trash }}

Описание метода
Method is available with the token of the Promotion category

Returns list of nomenclatures in trash.

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

  1. Make the first request:
            {
              "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.
Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Enum: "ru" "en" "zh"

Language of name, value and object parameters

Request Body schema: application/json
required
object

Settings

Responses

Request samples

Content type
application/json
{
  • "settings": {
    }
}

Response samples

Content type
application/json
{}

Tags

To access the methods, use a token for the Content category
Service for operating with the tags of product cards. Tags are designed to quickly find a product card in your user panel.

Tags list{{ /content/v2/tags }}

Описание метода

Returns seller's tags list

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": false,
  • "errorText": "",
  • "additionalErrors": ""
}

Create a tag{{ /content/v2/tag }}

Описание метода

Creates a tag. It is possible to create 15 tags. The maximum length of a tag is 15 characters

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
color
string

Tag color.

Available colors:
D1CFD7 - grey
FEE0E0 - red
ECDAFF - purple
E4EAFF - blue
DEF1DD - green
FFECC7 - yellow

name
string

Tag name

Responses

Request samples

Content type
application/json
{
  • "color": "D1CFD7",
  • "name": "Sale"
}

Response samples

Content type
application/json

Success

{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Update the tag{{ /content/v2/tag/{id} }}

Описание метода

Changes tag data: name and color

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
id
required
integer
Example: 1

Numeric tag ID

Request Body schema: application/json
required
color
string

Tag color

name
string

Tag name

Responses

Request samples

Content type
application/json
{
  • "color": "D1CFD7",
  • "name": "Sale"
}

Response samples

Content type
application/json
Example

Success

{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Delete the tag{{ /content/v2/tag/{id} }}

Описание метода

Deletes the tag

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
id
required
integer
Example: 1

Numeric tag ID

Responses

Response samples

Content type
application/json
Example

Success

{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Tag management in the product card{{ /content/v2/tag/nomenclature/link }}

Описание метода

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.

Maximum of 100 requests per minute for all methods in the Content category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmID
integer

WB article

tagsIDs
Array of integers

An array of numeric tag IDs.
When removing a tag from a product card, the tag itself is not removed.
To add tags to existing ones in the product card, you need to specify in the request the new tags and the tags that are already exist in the product card.

Responses

Request samples

Content type
application/json
{
  • "nmID": 179891389,
  • "tagsIDs": [
    ]
}

Response samples

Content type
application/json

Success

{
  • "data": null,
  • "error": false,
  • "errorText": "",
  • "additionalErrors": null
}

Prices and Discounts

To access the methods, use a token for the Prices and Discounts category

Methods to set prices and discounts.

When you update price or discounts, some product data may be not updated. For example, if you set incorrect price or discount. Check the upload status with the processed upload state methods.

Upload status:

  • 3 — processed, no errors in products, prices and discounts were updated
  • 4 — canceled
  • 5 — processed, but some products have errors. Prices and Discounts for the other products were updated. You can get errors with the processed upload details method.
  • 6 — processed, but all products have errors. You can get errors with the processed upload details method too.

If you set prices and discounts in seller's account, with promo calendar, the upload is processing. Prices and Discounts will be updated to promo start.

This upload has status 1, and you can get upload state and details with unprocessed upload details and unprocessed upload state methods.

There is no upload status 2.

Set prices and discounts{{ /api/v2/upload/task }}

Описание метода

Sets prices and discounts

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array of objects (Goods)

Products, prices and discounts. Maximum 1,000 products. Both price and discount can not be empty

If the new price with discount is at least 3 times less than the previous one, the price will go into price quarantine and will not change. You will get the error in the response of upload states methods.

You can edit price/discount using API or remove the price out of quarantine in your account

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Sets size prices{{ /api/v2/upload/task/size }}

Описание метода

Sets different prices for different sizes.

Only for products from categories where size price setting is available. For these products editableSizePrice: true in Get product sizes response.

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array of objects (SizeGoodsBody)

Sizes and prices. Maximum 1,000 sizes

If the new price with discount is at least 3 times less than the previous one, the price will go into price quarantine and will not change. You will get the error in the response of Upload states methods.

You can edit price/discount using API or remove the price out of quarantine in your account

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Set WB Club discounts{{ /api/v2/upload/task/club-discount }}

Описание метода

Sets WB Club subscription discounts

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array of objects (ClubDisc)

Products and WB Club discounts. Maximum 1,000 products.

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Processed upload state{{ /api/v2/history/tasks }}

Описание метода

Returns the processed upload data

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
uploadID
required
integer
Example: uploadID=146567

Download ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "The product is in quarantine"
}

Processed upload details{{ /api/v2/history/goods/task }}

Описание метода

Returns products in processed upload including product errors

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint>
Example: limit=10

Number of elements per page (pagination). Maximum 1,000 elements

offset
integer <uint> >= 0
Example: offset=0

From which element to start outputting data

uploadID
required
integer
Example: uploadID=146567

Download ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Unprocessed upload state{{ /api/v2/buffer/tasks }}

Описание метода

Returns the processing upload data

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
uploadID
required
integer
Example: uploadID=146567

Download ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Unprocessed upload details{{ /api/v2/buffer/goods/task }}

Описание метода

Returns products in processing upload including product errors

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint>
Example: limit=10

Number of elements per page (pagination). Maximum 1,000 elements

offset
integer <uint> >= 0
Example: offset=0

From which element to start outputting data

uploadID
required
integer
Example: uploadID=146567

Download ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Get products{{ /api/v2/list/goods/filter }}

Описание метода

Returns product data by its article. To get data for all products, do not set the article

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint>
Example: limit=10

Number of elements per page (pagination). Maximum 1,000 elements

offset
integer <uint> >= 0
Example: offset=0

From which element to start outputting data

filterNmID
integer
Example: filterNmID=44589768676

WB article to search

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get product sizes{{ /api/v2/list/goods/size/nm }}

Описание метода

Returns sizes data for the product. Only for products from categories where size price setting is available. For these products editableSizePrice: true

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint>
Example: limit=10

Number of elements per page (pagination). Maximum 1,000 elements

offset
integer <uint> >= 0
Example: offset=0

From which element to start outputting data

nmID
required
integer
Example: nmID=1

WB article

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": "string"
}

Get products in quarantine{{ /api/v2/quarantine/goods }}

Описание метода

Returns information about products in quarantine.

If the product new price with discount will be minimum 3 times less than the old price, the product will be placed in quarantine and will be sold at the old price. An error about this will be in upload states method response.

You can change price or discount via API or release product from quarantine in personal account.

For products with size-based pricing, quarantine does not apply

Maximum of 10 requests per 6 seconds for all methods in the Prices and Discounts category per one seller's account
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer <uint>
Example: limit=10

Number of elements per page (pagination). Maximum 1,000 elements

offset
integer <uint> >= 0
Example: offset=0

From which element to start outputting data

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": false,
  • "errorText": ""
}

Seller Warehouses

To access the methods, use a token for the Marketplace category

Get offices{{ /api/v3/offices }}

Описание метода

Returns a list of all offices to link to seller warehouse.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get warehouses{{ /api/v3/warehouses }}

Описание метода

Returns a list of all seller's warehouses

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create warehouse{{ /api/v3/warehouses }}

Описание метода

Creates a seller's warehouse. You cannot link an office that is already in use.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Supplier's warehouse name

officeId
required
integer >= 1

Office ID

Responses

Request samples

Content type
application/json
{
  • "name": "Koledino 2",
  • "officeId": 15
}

Response samples

Content type
application/json
{
  • "id": 2
}

Update warehouse{{ /api/v3/warehouses/{warehouseId} }}

Описание метода

Updates the seller's warehouse details. Changing the linked office is allowed once per day. You cannot link an office that is already in use

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Supplier's warehouse name

officeId
required
integer >= 1

Office ID

Responses

Request samples

Content type
application/json
{
  • "name": "Koledino",
  • "officeId": 15
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Delete warehouse{{ /api/v3/warehouses/{warehouseId} }}

Описание метода

Deletes the supplier's warehouse.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Responses

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Inventory

To access the methods, use a token for the Marketplace category
Inventory in sellers' warehouses

Get inventory{{ /api/v3/stocks/{warehouseId} }}

Описание метода

Returns product inventory

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Request Body schema: application/json
required
skus
Array of strings [ 1 .. 1000 ] items

SKUs array

Responses

Request samples

Content type
application/json
{
  • "skus": [
    ]
}

Response samples

Content type
application/json
{
  • "stocks": [
    ]
}

Update inventory{{ /api/v3/stocks/{warehouseId} }}

Описание метода

Updates product inventory

The names of the query parameters are not validated. If invalid names are sent, the response will be successful(204), but the remaining amounts will not be updated.
Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Request Body schema: application/json
required
Array of objects [ 1 .. 1000 ] items

SKU array

Responses

Request samples

Content type
application/json
{
  • "stocks": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Delete inventory{{ /api/v3/stocks/{warehouseId} }}

Описание метода

Deletes product inventory

This action is irreversible. Deleted stock will require re-uploading to continue sales
Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Request Body schema: application/json
required
skus
Array of strings [ 1 .. 1000 ] items

SKUs array

Responses

Request samples

Content type
application/json
{
  • "skus": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}