Не допускается использование API Контента в качестве внешней базы данных. При превышении лимитов на запросы доступ к API будет ограничен.
Создание карточки товара происходит асинхронно, при отправке запроса на создание карточки ваш запрос становится в очередь на создание.
Внимание. Карточка считается созданной, если создалась хотя бы одна номенклатура в ней. Если во время обработки запроса в очереди выявляются ошибки, то номенклатура считается ошибочной.
Как создать карточку:
Родительские категории товаров
Список предметов (подкатегорий)
Характеристики предмета (подкатегории)
. Для характеристик Цвет, Страна производства, Сезон, Ставка НДС, ТНВЭД используйте значения из раздела Конфигуратор
.Список несозданных номенклатур (НМ) с ошибками
.В одном запросе можно создать максимум 100 карточек (imtID
) и по 30 номенклатур (nmID
) в каждой. Максимальный размер запроса 10 Мб.
Габариты товаров можно указать только в сантиметрах.
subjectID required | integer ID предмета |
required | Array of objects Массив вариантов товара. В каждой КТ может быть не более 30 вариантов (НМ) |
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
object or string Дополнительные ошибки |
[- {
- "subjectID": 105,
- "variants": [
- {
- "vendorCode": "АртикулПродавца",
- "title": "Наименование товара",
- "description": "Описание товара",
- "brand": "Бренд",
- "dimensions": {
- "length": 55,
- "width": 40,
- "height": 15
}, - "characteristics": [
- {
- "id": 12,
- "value": [
- "Turkish flag"
]
}, - {
- "id": 25471,
- "value": 1200
}, - {
- "id": 14177449,
- "value": [
- "red"
]
}
], - "sizes": [
- {
- "techSize": "S",
- "wbSize": "42",
- "price": 5000,
- "skus": [
- "88005553535"
]
}
]
}
]
}
]
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": { }
}
Обновляет карточку товара. Данные для обновления можно получить с помощью метода Список номенклатур (НМ)
Нельзя редактировать или удалить баркоды, но можно добавить баркод к существующему. Параметры photos
, video
и tags
передавать не обязательно, их нельзя редактировать или удалять в этом методе.
Если ответ Успешно (200), но какие-то карточки не изменились, проверьте ошибки с помощью метода Список несозданных номенклатур (НМ) с ошибками
.
В одном запросе можно отредактировать максимум 3000 номенклатур (nmID
). Максимальный размер запроса 10 Мб.
Габариты товаров можно указать только в сантиметрах.
nmID required | integer Артикул WB |
vendorCode required | string Артикул продавца |
brand | string Бренд |
title | string Наименование товара |
description | string Описание товара. Максимальное количество символов зависит от категории товара. Стандарт — 2000, минимум — 1000, максимум — 5000. |
object Габариты упаковки товара. Указывать в сантиметрах для любого товара. | |
Array of objects Характеристики товара | |
required | Array of objects Массив размеров артикула. |
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
object or string Дополнительные ошибки |
[- {
- "nmID": 11111111,
- "vendorCode": "wbiz72wmro",
- "brand": "",
- "title": "Свитер женский оверсайз с горлом",
- "description": "12345",
- "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0
}, - "characteristics": [
- {
- "id": 14177450,
- "value": [
- "хлопок 50% акрил 50%"
]
}, - {
- "id": 50,
- "value": [
- "свободный крой"
]
}
], - "sizes": [
- {
- "chrtID": 12345678,
- "techSize": "ONE SIZE",
- "wbSize": "78-90",
- "skus": [
- "123487653460134"
]
}
]
}
]
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": { }
}
Метод позволяет добавить к карточке товара новую номенклатуру.
Добавление НМ к КТ происходит асинхронно, после отправки запрос становится в очередь на обработку.
Важно!
Если после успешной отправки запроса номенклатура не создалась, то необходимо проверить раздел "Список несозданных НМ с ошибками".
Для того чтобы убрать НМ из ошибочных, необходимо повторно сделать запрос с исправленными ошибками.
Максимальный размер запроса 10 Мб.
Габариты товаров можно указать только в сантиметрах.
imtID | integer imtID КТ, к которой добавляется НМ |
Array of objects Структура добавляемой НМ |
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
object or string Дополнительные ошибки |
{- "imtID": 987654321,
- "cardsToAdd": [
- {
- "vendorCode": "myVariant1",
- "title": "Наименование товара",
- "description": "Описание товара",
- "brand": "Бренд",
- "dimensions": {
- "length": 55,
- "width": 40,
- "height": 15
}, - "characteristics": [
- {
- "id": 12,
- "value": [
- "Russian flag"
]
}, - {
- "id": 25471,
- "value": 1300
}, - {
- "id": 14177449,
- "value": [
- "blue"
]
}
], - "sizes": [
- {
- "skus": [
- "12345678"
]
}
]
}, - {
- "vendorCode": "myVariant2",
- "title": "Наименование товара",
- "description": "Описание товаров",
- "brand": "Бренд",
- "dimensions": {
- "length": 55,
- "width": 40,
- "height": 15
}, - "characteristics": [
- {
- "id": 12,
- "value": [
- "Russian flag"
]
}, - {
- "id": 25471,
- "value": 1300
}, - {
- "id": 14177449,
- "value": [
- "blue"
]
}
], - "sizes": [
- {
- "skus": [
- "222222222222"
]
}
]
}
]
}
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": { }
}
Метод позволяет объединять номенклатуры (nmID
) под одним imtID
и разъединять их.
Для объединения НМ необходимо отправить запрос со списком НМ с заполненным параметром targetIMT
в теле запроса.
При этом все НМ объединятся под imtID
указанном в targetIMT
.
Чтобы отсоединить НМ от карточки, необходимо передать эту НМ без параметра targetIMT
в теле запроса.
При этом для передаваемой НМ создается новый imtID
.
Если в запросе на разъединение передается несколько НМ, то все они автоматически объединятся под одним новым imtID
.
Чтобы присвоить каждой НМ уникальный imtID
необходимо передавать по одной НМ за запрос.
Для НМ, не участвующих в запросе, никаких изменений не происходит.
Максимальный размер запроса 10 Мб.
ВАЖНО:
Объединить можно только номенклатуры с одинаковыми предметами.
ВАЖНО:
В одной КТ (под одним imtID
) не может быть больше 30 номенклатур (nmID
).
targetIMT required | integer Существующий у продавца |
nmIDs required | Array of integers
|
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
object or string Дополнительные ошибки |
{- "targetIMT": 123,
- "nmIDs": [
- 837459235,
- 828572090
]
}
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": { }
}
Метод позволяет сгенерировать массив уникальных баркодов для создания размера НМ в КТ.
count | integer Кол-во баркодов которые надо сгенерировать, максимальное доступное количество баркодов для генерации - |
data | Array of strings Массив сгенерированных баркодов |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string Дополнительные ошибки |
{- "count": 100
}
{- "data": [
- "5032781145187"
], - "error": false,
- "errorText": "",
- "additionalErrors": ""
}
Метод позволяет получить список созданных НМ с фильтрацией по разным параметрам, пагинацией и сортировкой.
Метод доступен по токену с опцией Продвижение
Важно. Карточки, находящиеся в корзине, в ответе метода не выдаются.
Получить такие карточки можно только методом "Список НМ, находящихся в корзине".
Порядок работы с get/cards/list
:
Чтобы получить полный список номенклатур, если их больше 100, необходимо воспользоваться пагинацией.
{ "settings": {
"cursor": { "limit": 100 }, "filter": { "withPhoto": -1 } } }
cursor
две строки:
"updatedAt": "***"
,"nmID": ***
,cursor
запроса, повторить вызов метода. total
в ответе не станет меньше чем limit
в запросе.
locale | string Example: locale=ru Язык для перевода полей ответа Не используется в песочнице. |
object Настройки |
Array of objects Список КТ | |
object Пагинатор |
{- "settings": {
- "sort": {
- "ascending": false
}, - "filter": {
- "textSearch": "",
- "allowedCategoriesOnly": true,
- "tagIDs": [ ],
- "objectIDs": [ ],
- "brands": [ ],
- "imtID": 0,
- "withPhoto": -1
}, - "cursor": {
- "updatedAt": "",
- "nmID": 0,
- "limit": 11
}
}
}
{- "cards": [
- {
- "nmID": 12345678,
- "imtID": 123654789,
- "nmUUID": "01bda0b1-5c0b-736c-b2be-d0a6543e9be",
- "subjectID": 7771,
- "subjectName": "AKF системы",
- "vendorCode": "wb7f6mumjr1",
- "brand": "",
- "title": "",
- "description": "",
- "photos": [
- {
}
], - "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "isValid": false
}, - "characteristics": [
- {
- "id": 14177449,
- "name": "Цвет",
- "value": [
- "красно-сиреневый"
]
}
], - "sizes": [
- {
- "chrtID": 316399238,
- "techSize": "0",
- "skus": [
- "987456321654"
]
}
], - "tags": [
- {
- "id": 592569,
- "name": "Популярный",
- "color": "D1CFD7"
}
], - "createdAt": "2023-12-06T11:17:00.96577Z",
- "updatedAt": "2023-12-06T11:17:00.96577Z"
}
], - "cursor": {
- "updatedAt": "2023-12-06T11:17:00.96577Z",
- "nmID": 123654123,
- "total": 1
}
}
Метод позволяет получить список НМ и список ошибок которые произошли во время создания КТ. ВАЖНО
: Для того чтобы убрать НМ из ошибочных, надо повторно сделать запрос с исправленными ошибками на создание КТ.
locale | string Example: locale=en Параметр выбора языка значений полей ответа (для которых предусмотрена мультиязычность). Не используется в песочнице. |
Array of objects | |
error | boolean Флаг ошибки. |
errorText | string Описание ошибки. |
additionalErrors | string Дополнительные ошибки. |
{- "data": [
- {
- "object": "Блузки",
- "vendorCode": "6000000001",
- "updateAt": "2022-06-15T14:37:13Z",
- "errors": [
- "Поля Рос. размер, Размер обязательны для заполнения"
], - "objectID": 41
}
], - "error": false,
- "errorText": "",
- "additionalErrors": ""
}
Метод позволяет получить отдельно бесплатные и платные лимиты продавца на создание карточек товаров.
Формула для получения количества карточек, которые можно создать: (freeLimits
+ paidLimits
) - Количество созданных карточек.
Созданными считаются все карточки, которые можно получить методами "Список НМ" и "Список НМ, находящихся в корзине".
object | |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string or null Дополнительные ошибки |
{- "data": {
- "freeLimits": 1500,
- "paidLimits": 10
}, - "error": false,
- "errorText": "",
- "additionalErrors": null
}
С помощью данного метода можно получить список всех родительских категорий товаров.
locale | string Example: locale=en Параметр выбора языка (ru, en, zh) значений поля name. Не используется в песочнице |
Array of objects | |
error | boolean Флаг наличия ошибки |
errorText | string Описание ошибки |
additionalErrors | string Дополнительные ошибки |
{- "data": [
- {
- "name": "Электроника",
- "id": 479,
- "isVisible": true
}
], - "error": false,
- "errorText": "",
- "additionalErrors": ""
}
С помощью данного метода можно получить список всех доступных предметов, родительских категорий предметов, и их идентификаторов.
name | string Example: name=Носки Поиск по наименованию предмета (Носки), поиск работает по подстроке, искать можно на любом из поддерживаемых языков. |
limit | integer Example: limit=1000 Количество подкатегорий (предметов), максимум 1 000 |
locale | string Example: locale=en Язык полей ответа (ru, en, zh). Не используется в песочнице |
offset | integer Example: offset=5000 Номер позиции, с которой необходимо получить ответ |
parentID | integer Example: parentID=1000 Идентификатор родительской категории предмета |
Array of objects Подкатегории (предметы) | |
error | boolean Флаг наличия ошибки |
errorText | string Текст ошибки |
additionalErrors | string Дополнительные ошибки |
{- "data": [
- {
- "subjectID": 2560,
- "parentID": 479,
- "subjectName": "3D очки",
- "parentName": "Электроника"
}, - {
- "subjectID": 1152,
- "parentID": 858,
- "subjectName": "3D-принтеры",
- "parentName": "Оргтехника"
}
], - "error": false,
- "errorText": "",
- "additionalErrors": null
}
Получение списка характеристик предмета по его ID.
subjectId required | integer Example: 105 Идентификатор предмета |
locale | string Example: locale=en Параметр выбора языка (ru, en, zh) значений полей |
Array of objects Данные | |
error | boolean Флаг наличия ошибки |
errorText | string Текст ошибки |
additionalErrors | string Дополнительные ошибки |
{- "data": [
- {
- "charcID": 54337,
- "subjectName": "Кроссовки",
- "subjectID": 105,
- "name": "Размер",
- "required": false,
- "unitName": "см",
- "maxCount": 0,
- "popular": false,
- "charcType": 4
}
], - "error": false,
- "errorText": "",
- "additionalErrors": null
}
Получение значения характеристики цвет.
locale | string Example: locale=en Параметр выбора языка (ru, en, zh) значений полей |
Array of objects | |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string Дополнительные ошибки |
{- "data": [
- {
- "name": "персиковый мелок",
- "parentName": "оранжевый"
}
], - "error": false,
- "errorText": "",
- "additionalErrors": ""
}
Получение значения характеристики пол.
locale | string Example: locale=en Параметр выбора языка (ru, en, zh) значений полей |
data | Array of strings Массив значений для хар-ки Пол |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string Дополнительные ошибки |
{- "data": [
- "Мужской"
], - "error": false,
- "errorText": "",
- "additionalErrors": ""
}
Получение значения характеристики Страна Производства.
locale | string Example: locale=en Параметр выбора языка (ru, en, zh) значений полей |
Array of objects | |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string Дополнительные ошибки |
{- "data": [
- {
- "name": "Афганистан",
- "fullName": "Исламский Эмират Афганистан"
}
], - "error": false,
- "errorText": "",
- "additionalErrors": ""
}
Получение значения характеристики Сезон.
locale | string Example: locale=en Параметр выбора языка (ru, en, zh) значений полей |
data | Array of strings Массив значений для хар-ки Сезон |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string Дополнительные ошибки |
{- "data": [
- "демисезон"
], - "error": false,
- "errorText": "",
- "additionalErrors": ""
}
С помощью данного метода можно получить список ТНВЭД кодов по ID предмета и фильтру по ТНВЭД коду.
subjectID required | integer Example: subjectID=105 Идентификатор предмета |
search | integer Example: search=6106903000 Поиск по ТНВЭД-коду. Работает только в паре с subjectID |
locale | string Example: locale=en Язык ( |
Array of objects Данные | |
error | boolean Флаг наличия ошибки |
errorText | string Текст ошибки |
additionalErrors | string Дополнительные ошибки |
{- "data": [
- {
- "tnved": "6106903000",
- "isKiz": true
}
], - "error": false,
- "errorText": "",
- "additionalErrors": null
}
С помощью данного метода можно получить список значений для характеристики Ставка НДС.
locale required | string Example: locale=ru Язык значения элементов |
data | Array of strings |
error | boolean Флаг наличия ошибки |
errorText | string Текст ошибки |
additionalErrors | string Дополнительные ошибки |
{- "data": [
- "0",
- "10",
- "20",
- "Без НДС",
- "13"
], - "error": false,
- "errorText": "",
- "additionalErrors": null
}
Изменяет набор медиафайлов для товара (номенклатуры).
Внимание. Новые медиафайлы (data
) полностью заменяют старые (mediaFiles
). Чтобы добавить новые медиафайлы, укажите ссылки не только на них, но и на старые файлы.
Требования к изображениям:
Требования к видео:
Если хотя бы одно изображение в запросе не соответствует требованиям, то даже при успешном ответе (200) ни одно изображение не загрузится
nmId | integer Артикул Wildberries |
data | Array of strings Ссылки на изображения в том порядке, в котором они будут на карточке товара |
data | object |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | object Дополнительные ошибки |
{- "nmId": 213864079,
}
{- "data": { },
- "error": false,
- "errorText": "",
- "additionalErrors": null
}
Добавляет один медиафайл для товара (номенклатуры).
Требования к изображениям:
Требования к видео:
X-Nm-Id required | string Example: 213864079 Артикул Wildberries |
X-Photo-Number required | integer Example: 2 Номер медиафайла на загрузку, начинается с Чтобы добавить изображение к уже загруженным, номер медиафайла должен быть больше количества уже загруженных медиафайлов. |
uploadfile | string <binary> |
data | object |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | object Дополнительные ошибки |
{- "data": { },
- "error": false,
- "errorText": "",
- "additionalErrors": null
}
Метод позволяет создать тег.
Завести можно 15 тегов.
Максимальная длина тега 15 символов.
color | string Цвет тега.
|
name | string Имя тега |
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string or null Дополнительные ошибки |
{- "color": "D1CFD7",
- "name": "Sale"
}
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": null
}
Метод позволяет изменять информацию о теге (имя и цвет).
id required | integer Example: 1 Числовой идентификатор тега |
color | string Цвет тега |
name | string Имя тега |
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string or null Дополнительные ошибки |
{- "color": "D1CFD7",
- "name": "Sale"
}
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": null
}
Метод позволяет удалить тег
id required | integer Example: 1 Числовой идентификатор тега |
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string or null Дополнительные ошибки |
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": null
}
Метод позволяет добавить теги к КТ и снять их с КТ.
При снятии тега с КТ сам тег не удаляется.
К карточке можно добавить 15 тегов.
nmID | integer Артикул WB |
tagsIDs | Array of integers Массив числовых идентификаторов тегов. |
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | string or null Дополнительные ошибки |
{- "nmID": 179891389,
- "tagsIDs": [
- 123456
]
}
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": null
}
Метод позволяет перенести НМ в корзину. Перенос карточки в корзину не является удалением карточки.
ВАЖНО
: При переносе НМ в корзину, данная НМ выходит из КТ, то есть ей присваивается новый imtID
.
Карточка товара удаляется автоматически, если лежит в корзине больше 30 дней.
Корзина зачищается от карточек, лежащих в ней более 30 дней, каждую ночь по Московскому времени.
nmIDs | Array of integers Артикул WB (max. 1000) |
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | object Дополнительные ошибки |
{- "nmIDs": [
- 987654321,
- 123456789
]
}
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": { }
}
Метод позволяет восстановить НМ из корзины.
ВАЖНО
: При восстановлении НМ из корзины она не возвращается в КТ в которой была до переноса в корзину, то есть imtID
остается тот же, что и был у НМ в корзине.
nmIDs | integer Артикул WB (max. 1000) |
data | object or null |
error | boolean Флаг ошибки |
errorText | string Описание ошибки |
additionalErrors | object Дополнительные ошибки |
{- "nmIDs": [
- 123456789,
- 987654321
]
}
{- "data": null,
- "error": false,
- "errorText": "",
- "additionalErrors": { }
}
Метод позволяет получить список НМ, находящихся в корзине.
Метод доступен по токену с опцией Продвижение
Порядок работы.
Чтобы получить полный список номенклатур, если их больше 100, необходимо воспользоваться пагинацией.
{ "settings": {
"cursor": { "limit": 100 } } }
cursor
две строки:
"trashedAt": "***"
,"nmID": ***
,cursor
запроса, повторить вызов метода. total
в ответе не станет меньше чем limit
в запросе.
locale | string Enum: "ru" "en" "zh" Язык полей ответа Не используется в песочнице |
object Настройки |
Array of objects Массив карточек товаров | |
object |
{- "settings": {
- "sort": {
- "ascending": false
}, - "filter": {
- "textSearch": ""
}, - "cursor": {
- "limit": 11
}
}
}
{- "cards": [
- {
- "nmID": 1234567,
- "vendorCode": "wb5xsy5ftj",
- "subjectID": 1436,
- "subjectName": "Ведра хозяйственные",
- "photos": [
- {
}
], - "sizes": [
- {
- "chrtID": 111111111,
- "techSize": "0",
- "skus": [
- "xxxxxxxxxxxx"
]
}
], - "dimensions": {
- "length": 0,
- "width": 0,
- "height": 0,
- "isValid": false
}, - "createdAt": "2023-12-05T14:55:09.323462Z",
- "trashedAt": "2023-12-06T10:57:42.193028Z"
}
], - "cursor": {
- "trashedAt": "2023-12-06T10:57:42.193028Z",
- "nmID": 194128521,
- "total": 1
}
}