- Request
- Path parameters
- Query parameters
- CatalogLanguageType
- Body
- ShopSku
- OfferName
- PartnerMarketCategoryId
- OfferCategory
- Url
- OfferManualDTO
- OfferVendor
- OfferBarcodes
- OfferDescription
- BaseOfferManufacturerCountries
- OfferWeightDimensionsDTO
- OfferVendorCode
- BaseOfferTags
- TimeUnitType
- TimePeriodDTO
- BaseOfferCustomsCommodityCode
- CommodityCodeType
- CommodityCodeDTO
- BaseOfferCommodityCodes
- BaseOfferBoxCount
- OfferConditionType
- OfferConditionQualityType
- OfferConditionDTO
- OfferType
- BaseOfferDownloadable
- BaseOfferAdult
- AgeUnitType
- AgeDTO
- OfferParamDTO
- BaseOfferParams
- BaseOfferDTO
- ParameterValueDTO
- CurrencyType
- BasePriceDTO
- DiscountBase
- PriceWithDiscountDTO
- DeleteOfferParameterType
- UpdateOfferDTO
- MarketSku
- UpdateMappingDTO
- UpdateOfferMappingDTO
- Responses
- 200 OK
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 423 Locked
- 500 Internal Server Error
Добавление товаров в каталог и изменение информации о них
Метод доступен для моделей: FBY, FBS, Экспресс и DBS.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- offers-and-cards-management — Управление товарами и карточками
- all-methods — Полное управление кабинетом
Добавляет товары в каталог и передает:
- их листовые категории на Маркете и категорийные характеристики;
- основные характеристики;
- цены на товары в кабинете.
Также объединяет товары на карточке, редактирует и удаляет информацию об уже добавленных товарах, в том числе цены в кабинете и категории товаров.
Список категорий Маркета можно получить с помощью запроса POST v2/categories/tree, а характеристики товаров по категориям с помощью POST v2/category/{categoryId}/parameters.
Добавить новый товар
Передайте его с новым идентификатором, который раньше никогда не использовался в каталоге.
Обязательно укажите параметры: offerId, name, marketCategoryId, pictures, vendor, description.
Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой.
Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.
Для продавцов Market Yandex Go:
Когда вы добавляете товары в каталог, указывайте значения параметров name и description на русском языке. Чтобы на витрине они отображались и на другом языке, еще раз выполните запрос POST v2/businesses/{businessId}/offer-mappings/update, где укажите:
- язык в параметре
language; - значения параметров
nameиdescriptionна указанном языке.
Повторно передавать остальные характеристики товара не нужно.
Изменить информацию о товаре
Передайте новые данные, указав в offerId SKU товара в вашей системе.
Поля, в которых ничего не меняется, можно не передавать.
Удалить переданные ранее параметры товара
В deleteParameters укажите значения параметров, которые хотите удалить. Можно передать сразу несколько значений.
Для параметров с типом string также можно передать пустое значение.
Параметр offerId (SKU товара в вашей системе) должен быть уникальным для всех товаров, которые вы передаете.
Правила использования SKU
-
У каждого товара SKU должен быть свой.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.
Данные в каталоге обновляются не мгновенно
Это занимает до нескольких минут.
| ⚙️ Лимит: 10 000 товаров в минуту, не более 100 товаров в одном запросе |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/offer-mappings/update
Path parameters
|
Name |
Description |
|
businessId |
Type: integer Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns. ℹ️ Что такое кабинет и магазин на Маркете Min value: |
Query parameters
|
Name |
Description |
|
language |
Type: CatalogLanguageType Язык, на котором принимаются и возвращаются значения в параметрах Значение по умолчанию: Язык:
Enum: |
CatalogLanguageType
Язык:
RU— русский.UZ— узбекский.
Type: string
Enum: RU, UZ
Body
application/json
{
"offerMappings": [
{
"offer": {
"offerId": "example",
"name": "Ударная дрель Makita HP1630, 710 Вт",
"marketCategoryId": 0,
"category": "example",
"pictures": [
null
],
"videos": [
null
],
"manuals": [
null
],
"vendor": "LEVENHUK",
"barcodes": [
null
],
"description": "example",
"manufacturerCountries": [
null
],
"weightDimensions": {},
"vendorCode": "VNDR-0005A",
"tags": [
null
],
"shelfLife": {},
"lifeTime": null,
"guaranteePeriod": null,
"customsCommodityCode": "8517610008",
"commodityCodes": [
null
],
"certificates": [
null
],
"boxCount": 1,
"condition": {},
"type": "DEFAULT",
"downloadable": true,
"adult": true,
"age": {},
"params": [
null
],
"parameterValues": [
null
],
"basicPrice": {},
"purchasePrice": {},
"additionalExpenses": null,
"firstVideoAsCover": true,
"deleteParameters": [
null
]
},
"mapping": {
"marketSku": 1
}
}
],
"onlyPartnerMediaContent": true
}
|
Name |
Description |
|
offerMappings |
Type: UpdateOfferMappingDTO[] Список товаров, которые нужно добавить или обновить. Скоро мы уменьшим максимальное количество товаров в запросе Уже сейчас не передавайте больше 100. Min items: Max items: Example
|
|
onlyPartnerMediaContent |
Type: boolean Будут ли использоваться только переданные вами данные о товарах. Значение по умолчанию: |
ShopSku
Ваш SKU — идентификатор товара в вашей системе.
Правила использования SKU:
-
У каждого товара SKU должен быть свой.
-
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.
Важно
Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.
Что такое SKU и как его назначать
Type: string
Min length: 1
Max length: 255
Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
Example: example
OfferName
Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.
Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.
Оптимальная длина — 50–60 символов.
Type: string
Max length: 256
Example: Ударная дрель Makita HP1630, 710 Вт
PartnerMarketCategoryId
Идентификатор категории на Маркете, к которой вы относите свой товар.
Всегда указывайте, когда передаете parameterValues
Если при изменении характеристик передать parameterValues и не указать marketCategoryId, характеристики обновятся, но в ответе придет предупреждение (параметр warnings).
Если не передать их оба, будет использована информация из устаревших параметров params и category, а marketCategoryId будет определен автоматически.
При изменении категории убедитесь, что характеристики товара и их значения в параметре parameterValues вы передаете для новой категории.
Список категорий Маркета можно получить с помощью запроса POST v2/categories/tree.
Type: integer
Min value: 0
Exclusive min: true
OfferCategory
Deprecated
Вместо него используйте marketCategoryId.
Категория товара в вашем магазине.
Type: string
Example: example
Url
Type: string
Min length: 1
Max length: 2000
Example: example
OfferManualDTO
Инструкция по использованию товара.
|
Name |
Description |
|
url |
Type: Url Ссылка на инструкцию. Min length: Max length: Example: |
|
title |
Type: string Название инструкции, которое будет отображаться на карточке товара. Max length: Example: |
Example
{
"url": "example",
"title": "example"
}
OfferVendor
Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
Type: string
Example: LEVENHUK
OfferBarcodes
Штрихкод.
Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128. Для книг — ISBN.
Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.
Что такое GTIN
Type: string[] | null
Min items: 1
Unique items: true
Example
[
"46012300000000"
]
OfferDescription
Подробное описание товара: например, его преимущества и особенности.
Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.
Для форматирования текста можно использовать теги HTML:
- <h>, <h1>, <h2> и так далее — для заголовков;
- <br> и <p> — для переноса строки;
- <ol> — для нумерованного списка;
- <ul> — для маркированного списка;
- <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
- <div> — поддерживается, но не влияет на отображение текста.
Оптимальная длина — 400–600 символов.
Type: string
Max length: 6000
Example: example
BaseOfferManufacturerCountries
Страна, где был произведен товар.
Записывайте названия стран так, как они записаны в списке.
Type: string[] | null
Min items: 1
Unique items: true
Example
[
"Россия"
]
OfferWeightDimensionsDTO
Габариты упаковки и вес товара.
Если товар занимает несколько коробок, перед измерением размеров сложите их компактно.

|
Name |
Description |
|
height |
Type: number Высота упаковки в см. Min value: |
|
length |
Type: number Длина упаковки в см. Min value: |
|
weight |
Type: number Вес товара в кг с учетом упаковки (брутто). Min value: |
|
width |
Type: number Ширина упаковки в см. Min value: |
Example
{
"length": 65.55,
"width": 50.7,
"height": 20,
"weight": 1.001
}
OfferVendorCode
Артикул товара от производителя.
Type: string
Example: VNDR-0005A
BaseOfferTags
Метки товара, которые использует магазин. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки.
Максимальная длина тега — 20 символов. У одного товара может быть максимум 10 тегов.
Type: string[] | null
Min items: 1
Max items: 50
Unique items: true
Example
[
"до 500 рублей"
]
TimeUnitType
Единица измерения времени:
HOUR— час.DAY— сутки.WEEK— неделя.MONTH— месяц.YEAR— год.
Type: string
Enum: HOUR, DAY, WEEK, MONTH, YEAR
TimePeriodDTO
Временной отрезок с комментарием. Требования к содержанию комментария зависят от контекста использования параметра и указаны в описании поля, которое его содержит.
|
Name |
Description |
|
timePeriod |
Type: integer Продолжительность в указанных единицах. |
|
timeUnit |
Type: TimeUnitType Единица измерения. Единица измерения времени:
Enum: |
|
comment |
Type: string Комментарий. Max length: Example: |
Example
{
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "example"
}
BaseOfferCustomsCommodityCode
Deprecated
Вместо него используйте commodityCodes с типом CUSTOMS_COMMODITY_CODE.
Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.
Обязательно укажите, если он есть.
Type: string
Example: 8517610008
CommodityCodeType
Тип товарного кода:
CUSTOMS_COMMODITY_CODE— код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.IKPU_CODE— идентификационный код продукции и услуг (ИКПУ) в Узбекистане – 17 цифр без пробелов.
Не передавайте несколько кодов одного типа.
Type: string
Enum: CUSTOMS_COMMODITY_CODE, IKPU_CODE
CommodityCodeDTO
Товарный код.
|
Name |
Description |
|
code |
Type: string Товарный код. Example: |
|
type |
Type: CommodityCodeType Тип товарного кода. Тип товарного кода:
Не передавайте несколько кодов одного типа. Enum: |
Example
{
"code": "example",
"type": "CUSTOMS_COMMODITY_CODE"
}
BaseOfferCommodityCodes
Товарные коды.
Type: CommodityCodeDTO[] | null
Min items: 1
Example
[
{
"code": "example",
"type": "CUSTOMS_COMMODITY_CODE"
}
]
BaseOfferBoxCount
Количество грузовых мест.
Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках.
Для товаров, занимающих одно место, не передавайте этот параметр.
Type: integer
Min value: 1
OfferConditionType
Тип уценки:
PREOWNED— бывший в употреблении товар, раньше принадлежал другому человеку.SHOWCASESAMPLE— витринный образец.REFURBISHED— повторная продажа товара.REDUCTION— товар с дефектами.RENOVATED— восстановленный товар.NOT_SPECIFIED— не выбран.
REFURBISHED — специальное значение для одежды, обуви и аксессуаров. Используется только для уцененных товаров из этой категории. Другие значения для одежды, обуви и аксессуаров не используются.
Type: string
Enum: PREOWNED, SHOWCASESAMPLE, REFURBISHED, REDUCTION, RENOVATED, NOT_SPECIFIED
OfferConditionQualityType
Внешний вид товара:
PERFECT— идеальный.EXCELLENT— отличный.GOOD— хороший.NOT_SPECIFIED— не выбран.
Type: string
Enum: PERFECT, EXCELLENT, GOOD, NOT_SPECIFIED
OfferConditionDTO
Состояние уцененного товара.
|
Name |
Description |
|
quality |
Type: OfferConditionQualityType Внешний вид товара. Внешний вид товара:
Enum: |
|
reason |
Type: string Описание товара. Подробно опишите дефекты, насколько они заметны и где их искать. Example: |
|
type |
Type: OfferConditionType Тип уценки. Тип уценки:
Enum: |
Example
{
"type": "PREOWNED",
"quality": "PERFECT",
"reason": "example"
}
OfferType
Особый тип товара:
DEFAULT— товары, для которых вы передавали особый тип ранее и хотите убрать его.MEDICINE— лекарства.BOOK— бумажные и электронные книги.AUDIOBOOK— аудиокниги.ARTIST_TITLE— музыкальная и видеопродукция.ON_DEMAND— товары на заказ.ALCOHOL— алкоголь.
Если ваш товар — книга
Укажите год издания в характеристиках товара. Подробнее о параметре
Type: string
Enum: DEFAULT, MEDICINE, BOOK, AUDIOBOOK, ARTIST_TITLE, ON_DEMAND, ALCOHOL
BaseOfferDownloadable
Признак цифрового товара. Укажите true, если товар доставляется по электронной почте.
Как работать с цифровыми товарами
Type: boolean
BaseOfferAdult
Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей.
Type: boolean
AgeUnitType
Единицы измерения возраста:
YEAR— год.MONTH— месяц.
Type: string
Enum: YEAR, MONTH
AgeDTO
Возраст в заданных единицах измерения.
|
Name |
Description |
|
ageUnit |
Type: AgeUnitType Единица измерения. Единицы измерения возраста:
Enum: |
|
value |
Type: number Значение. Min value: |
Example
{
"value": 0,
"ageUnit": "YEAR"
}
OfferParamDTO
Параметры товара.
Если у товара несколько значений одного параметра, передайте их с одним и тем же name, но разными value.
Пример
"params": [
{
"name": "Цвет для фильтра",
"value": "Зеленый"
},
{
"name": "Цвет для фильтра",
"value": "Желтый"
}
]
|
Name |
Description |
|
name |
Type: string Название характеристики. Должно совпадать с названием характеристики на Маркете. Узнать его можно из Excel-шаблона категории или через запрос POST v2/category/{categoryId}/parameters. Max length: Example: |
|
value |
Type: string Значение. Example: |
Example
{
"name": "Wi-Fi",
"value": "есть"
}
BaseOfferParams
Deprecated
При передаче характеристик используйте parameterValues.
Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви.
Type: OfferParamDTO[] | null
Min items: 1
Example
[
{
"name": "Wi-Fi",
"value": "есть"
}
]
BaseOfferDTO
Основные параметры товара.
|
Name |
Description |
|
offerId |
Type: ShopSku Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Важно Пробельные символы в начале и конце значения автоматически удаляются. Например, Что такое SKU и как его назначать Min length: Max length: Pattern: Example: |
|
adult |
Type: BaseOfferAdult Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей. Example: |
|
age |
Type: AgeDTO Если товар не предназначен для детей младше определенного возраста, укажите это. Возрастное ограничение можно задавать в годах (с нуля, с 6, 12, 16 или 18) или в месяцах (любое число от 0 до 12). Возраст в заданных единицах измерения. Example
|
|
barcodes |
Type: OfferBarcodes Штрихкод. Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128. Для книг — ISBN. Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN. Что такое GTIN Min items: Unique items: Example
|
|
boxCount |
Type: BaseOfferBoxCount Количество грузовых мест. Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках. Для товаров, занимающих одно место, не передавайте этот параметр. Min value: Example: |
|
category |
Type: OfferCategory Вместо него используйте Категория товара в вашем магазине. Example: |
|
certificates |
Type: string[] | null Номера документов на товар: сертификата, декларации соответствия и т. п. Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции. Min items: Max items: Unique items: Example
|
|
commodityCodes |
Type: BaseOfferCommodityCodes Товарные коды. Min items: Example
|
|
condition |
Type: OfferConditionDTO Состояние уцененного товара. Используется только для товаров, продаваемых с уценкой. Правила продажи уцененных товаров Состояние уцененного товара. Example
|
|
customsCommodityCode |
Type: BaseOfferCustomsCommodityCode Вместо него используйте Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов. Обязательно укажите, если он есть. Example: |
|
description |
Type: OfferDescription Подробное описание товара: например, его преимущества и особенности. Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок. Для форматирования текста можно использовать теги HTML:
Оптимальная длина — 400–600 символов. Max length: Example: |
|
downloadable |
Type: BaseOfferDownloadable Признак цифрового товара. Укажите Как работать с цифровыми товарами Example: |
|
guaranteePeriod |
Type: TimePeriodDTO Гарантийный срок — период, в течение которого можно заменить или починить товар без дополнительной платы. Обязательно указывайте срок, если он есть. В комментарии опишите особенности гарантийного обслуживания. Например, Временной отрезок с комментарием. Требования к содержанию комментария зависят от контекста использования параметра и указаны в описании поля, которое его содержит. Example
|
|
lifeTime |
Type: TimePeriodDTO Срок службы — период, в течение которого товар должен исправно выполнять свою функцию. Обязательно указывайте срок, если он есть. В комментарии укажите условия хранения. Например, Временной отрезок с комментарием. Требования к содержанию комментария зависят от контекста использования параметра и указаны в описании поля, которое его содержит. Example
|
|
manuals |
Type: OfferManualDTO[] | null Список инструкций по использованию товара. Min items: Max items: Example
|
|
manufacturerCountries |
Type: BaseOfferManufacturerCountries Страна, где был произведен товар. Записывайте названия стран так, как они записаны в списке. Min items: Unique items: Example
|
|
marketCategoryId |
Type: PartnerMarketCategoryId Идентификатор категории на Маркете, к которой вы относите свой товар. Всегда указывайте, когда передаете Если при изменении характеристик передать Если не передать их оба, будет использована информация из устаревших параметров При изменении категории убедитесь, что характеристики товара и их значения в параметре Список категорий Маркета можно получить с помощью запроса POST v2/categories/tree. Min value: Exclusive min: Example: |
|
name |
Type: OfferName Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке. Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей. Оптимальная длина — 50–60 символов. Max length: Example: |
|
params |
Type: BaseOfferParams При передаче характеристик используйте Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви. Min items: Example
|
|
pictures |
Type: Url[] | null Ссылки на изображения товара. Изображение по первой ссылке считается основным, остальные дополнительными. Требования к ссылкам
✅ ✅ ❌ ❌ Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке. Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится. Min items: Max items: Example
|
|
shelfLife |
Type: TimePeriodDTO Срок годности — период, по прошествии которого товар становится непригоден. Указывайте срок, указанный на банке или упаковке. Текущая дата, дата поставки или дата отгрузки значения не имеет. Обязательно указывайте срок, если он есть. В комментарии укажите условия хранения. Например, Временной отрезок с комментарием. Требования к содержанию комментария зависят от контекста использования параметра и указаны в описании поля, которое его содержит. Example
|
|
tags |
Type: BaseOfferTags Метки товара, которые использует магазин. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки. Максимальная длина тега — 20 символов. У одного товара может быть максимум 10 тегов. Min items: Max items: Unique items: Example
|
|
type |
Type: OfferType Особый тип товара. Указывается, если товар:
Особый тип товара:
Если ваш товар — книга Укажите год издания в характеристиках товара. Подробнее о параметре Enum: |
|
vendor |
Type: OfferVendor Название бренда или производителя. Должно быть записано так, как его пишет сам бренд. Example: |
|
vendorCode |
Type: OfferVendorCode Артикул товара от производителя. Example: |
|
videos |
Type: Url[] | null Ссылки (URL) на видео товара. Требования к ссылке
✅ ✅ ❌ ❌ Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке. Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится. Min items: Max items: Example
|
|
weightDimensions |
Type: OfferWeightDimensionsDTO Габариты упаковки и вес товара. Должны быть больше 0. Габариты упаковки и вес товара. Если товар занимает несколько коробок, перед измерением размеров сложите их компактно.
Example
|
Example
{
"offerId": "example",
"name": "Ударная дрель Makita HP1630, 710 Вт",
"marketCategoryId": 0,
"category": "example",
"pictures": [
"example"
],
"videos": [
null
],
"manuals": [
{
"url": null,
"title": "example"
}
],
"vendor": "LEVENHUK",
"barcodes": [
"46012300000000"
],
"description": "example",
"manufacturerCountries": [
"Россия"
],
"weightDimensions": {
"length": 65.55,
"width": 50.7,
"height": 20,
"weight": 1.001
},
"vendorCode": "VNDR-0005A",
"tags": [
"до 500 рублей"
],
"shelfLife": {
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "example"
},
"lifeTime": null,
"guaranteePeriod": null,
"customsCommodityCode": "8517610008",
"commodityCodes": [
{
"code": "example",
"type": "CUSTOMS_COMMODITY_CODE"
}
],
"certificates": [
"example"
],
"boxCount": 1,
"condition": {
"type": "PREOWNED",
"quality": "PERFECT",
"reason": "example"
},
"type": "DEFAULT",
"downloadable": true,
"adult": true,
"age": {
"value": 0,
"ageUnit": "YEAR"
},
"params": [
{
"name": "Wi-Fi",
"value": "есть"
}
]
}
ParameterValueDTO
Значение характеристики.
|
Name |
Description |
|
parameterId |
Type: integer Идентификатор характеристики. Min value: |
|
unitId |
Type: integer Идентификатор единицы измерения. Если вы не передали параметр |
|
value |
Type: string Значение. Для характеристик типа
Example: |
|
valueId |
Type: integer Идентификатор значения.
|
Example
{
"parameterId": 1,
"unitId": 0,
"valueId": 0,
"value": "example"
}
CurrencyType
Коды валют:
RUR— российский рубль.UAH— украинская гривна.BYR— белорусский рубль.KZT— казахстанский тенге.UZS— узбекский сум.
Type: string
Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE
BasePriceDTO
Цена товара.
|
Name |
Description |
|
currencyId |
Type: CurrencyType Валюта. Коды валют:
Enum: |
|
value |
Type: number Цена товара. Min value: Exclusive min: |
Example
{
"value": 0,
"currencyId": "RUR"
}
DiscountBase
Зачеркнутая цена.
Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.
Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.
Type: number
Min value: 0
Exclusive min: true
PriceWithDiscountDTO
Цена с указанием скидки.
Type: object
All of 2 types
-
Type: BasePriceDTO
Цена товара.
Example
{ "value": 0, "currencyId": "RUR" } -
Type: object
discountBase
Type: DiscountBase
Зачеркнутая цена.
Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.
Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.
Min value:
0Exclusive min:
trueExample:
0Example
{ "discountBase": 0 }
Example
{
"value": 0,
"currencyId": "RUR",
"discountBase": 0
}
DeleteOfferParameterType
Значения параметров, которые хотите удалить, и соответствующие параметры в UpdateOfferDTO, в которых вы передали эти значения ранее:
ADDITIONAL_EXPENSES— дополнительные расходы на товар (параметрadditionalExpenses).ADULT— пометка 18+ (параметрadult)AGE— возрастное ограничение для детей (параметрage).BARCODES— штрихкод (параметрbarcodes).BOX_COUNT— количество грузовых мест (параметрboxCount).CERTIFICATES— номера документов на товар (параметрcertificates).COMMODITY_CODES— товарные коды (параметрcommodityCodes).CONDITION— состояние уцененного товара (параметрcondition).CUSTOMS_COMMODITY_CODE— код товара в ТН ВЭД (параметрcustomsCommodityCode).DESCRIPTION— описание товара (параметрdescription).DOWNLOADABLE— признак цифрового товара (параметрdownloadable).GUARANTEE_PERIOD— гарантийный срок (параметрguaranteePeriod).LIFE_TIME— срок службы (параметрlifeTime).MANUALS— список инструкций по использованию товара (параметрmanuals).MANUFACTURER_COUNTRIES— страна производства (параметрmanufacturerCountries).PARAMETERS— характеристики товара (параметрыparams,parameterValues).PICTURES— ссылки на изображения товара (параметрpictures).PURCHASE_PRICE— себестоимость (параметрpurchasePrice).SHELF_LIFE— срок годности (параметрshelfLife).TAGS— метки товара, которые использует магазин (параметрtags).TYPE— особый тип товара (параметрtype).VENDOR_CODE— название бренда или производителя (параметрvendorCode).VIDEOS— ссылки на видео товара (параметрvideos).
Type: string
Enum: ADDITIONAL_EXPENSES, ADULT, AGE, BARCODES, BOX_COUNT, CERTIFICATES, COMMODITY_CODES, CONDITION, CUSTOMS_COMMODITY_CODE, DESCRIPTION, DOWNLOADABLE, GUARANTEE_PERIOD, LIFE_TIME, MANUALS, MANUFACTURER_COUNTRIES, PARAMETERS, PICTURES, PURCHASE_PRICE, SHELF_LIFE, TAGS, TYPE, VENDOR_CODE, VIDEOS
UpdateOfferDTO
Параметры товара.
Type: object
All of 2 types
-
Type: BaseOfferDTO
Основные параметры товара.
Example
{ "offerId": "example", "name": "Ударная дрель Makita HP1630, 710 Вт", "marketCategoryId": 0, "category": "example", "pictures": [ "example" ], "videos": [ null ], "manuals": [ { "url": null, "title": "example" } ], "vendor": "LEVENHUK", "barcodes": [ "46012300000000" ], "description": "example", "manufacturerCountries": [ "Россия" ], "weightDimensions": { "length": 65.55, "width": 50.7, "height": 20, "weight": 1.001 }, "vendorCode": "VNDR-0005A", "tags": [ "до 500 рублей" ], "shelfLife": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "lifeTime": null, "guaranteePeriod": null, "customsCommodityCode": "8517610008", "commodityCodes": [ { "code": "example", "type": "CUSTOMS_COMMODITY_CODE" } ], "certificates": [ "example" ], "boxCount": 1, "condition": { "type": "PREOWNED", "quality": "PERFECT", "reason": "example" }, "type": "DEFAULT", "downloadable": true, "adult": true, "age": { "value": 0, "ageUnit": "YEAR" }, "params": [ { "name": "Wi-Fi", "value": "есть" } ] } -
Type: object
additionalExpenses
Type: BasePriceDTO
Дополнительные расходы на товар. Например, на доставку или упаковку.
Цена товара.
Example
{ "value": 0, "currencyId": "RUR" }basicPrice
Type: PriceWithDiscountDTO
Цена.
Цена с указанием скидки.
Example
{ "value": 0, "currencyId": "RUR", "discountBase": 0 }deleteParameters
Type: DeleteOfferParameterType[] | null
Параметры, которые вы ранее передали в
UpdateOfferDTO, а теперь хотите удалить.Если передать
adult,downloadableиfirstVideoAsCover, они не удалятся — их значение изменится наfalse.Можно передать сразу несколько значений.
Не используйте вместе с соответствующим параметром в
UpdateOfferDTO. Это приведет к ошибке400.Min items:
1Unique items:
trueExample
[ "ADDITIONAL_EXPENSES" ]firstVideoAsCover
Type: boolean
Использовать первое видео в карточке как видеообложку.
Передайте
true, чтобы первое видео использовалось как видеообложка, илиfalse, чтобы видеообложка не отображалась в карточке товара.parameterValues
Type: ParameterValueDTO[] | null
Список характеристик с их значениями.
Всегда передавайте вместе с
marketCategoryIdЕсли не передать
marketCategoryIdпри изменении характеристик, они обновятся, но в ответе придет предупреждение (параметрwarnings).Если не передать их оба, будет использована информация из устаревших параметров
paramsиcategory, аmarketCategoryIdбудет определен автоматически.При изменении характеристик передавайте только те, значение которых нужно обновить. Если в
marketCategoryIdвы меняете категорию, значения общих характеристик для старой и новой категории сохранятся, передавать их не нужно.Подробнее читайте в «Передача значений характеристики».
Min items:
1Max items:
300Example
[ { "parameterId": 1, "unitId": 0, "valueId": 0, "value": "example" } ]purchasePrice
Type: BasePriceDTO
Себестоимость — затраты на самостоятельное производство товара или закупку у производителя или поставщиков.
Цена товара.
Example
{ "value": 0, "currencyId": "RUR" }Example
{ "parameterValues": [ { "parameterId": 1, "unitId": 0, "valueId": 0, "value": "example" } ], "basicPrice": { "value": 0, "currencyId": "RUR", "discountBase": 0 }, "purchasePrice": null, "additionalExpenses": null, "firstVideoAsCover": true, "deleteParameters": [ "ADDITIONAL_EXPENSES" ] }
Example
{
"offerId": "example",
"name": "Ударная дрель Makita HP1630, 710 Вт",
"marketCategoryId": 0,
"category": "example",
"pictures": [
"example"
],
"videos": [
null
],
"manuals": [
{
"url": null,
"title": "example"
}
],
"vendor": "LEVENHUK",
"barcodes": [
"46012300000000"
],
"description": "example",
"manufacturerCountries": [
"Россия"
],
"weightDimensions": {
"length": 65.55,
"width": 50.7,
"height": 20,
"weight": 1.001
},
"vendorCode": "VNDR-0005A",
"tags": [
"до 500 рублей"
],
"shelfLife": {
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "example"
},
"lifeTime": null,
"guaranteePeriod": null,
"customsCommodityCode": "8517610008",
"commodityCodes": [
{
"code": "example",
"type": "CUSTOMS_COMMODITY_CODE"
}
],
"certificates": [
"example"
],
"boxCount": 1,
"condition": {
"type": "PREOWNED",
"quality": "PERFECT",
"reason": "example"
},
"type": "DEFAULT",
"downloadable": true,
"adult": true,
"age": {
"value": 0,
"ageUnit": "YEAR"
},
"params": [
{
"name": "Wi-Fi",
"value": "есть"
}
],
"parameterValues": [
{
"parameterId": 1,
"unitId": 0,
"valueId": 0,
"value": "example"
}
],
"basicPrice": {
"value": 0,
"currencyId": "RUR",
"discountBase": 0
},
"purchasePrice": null,
"additionalExpenses": null,
"firstVideoAsCover": true,
"deleteParameters": [
"ADDITIONAL_EXPENSES"
]
}
MarketSku
Идентификатор карточки товара на Маркете.
Type: integer
Min value: 1
UpdateMappingDTO
Карточка на Маркете, которая, с вашей точки зрения, подходит товару. Чтобы определить идентификатор подходящей карточки, воспользуйтесь поиском в кабинете (Товары → Каталог → Загрузить товары).
По результатам проверки Маркет может привязать товар к более подходящей карточке.
|
Name |
Description |
|
marketSku |
Type: MarketSku Идентификатор карточки на Маркете. Идентификатор карточки товара на Маркете. Min value: Example: |
Example
{
"marketSku": 1
}
UpdateOfferMappingDTO
Информация о товаре.
|
Name |
Description |
|
offer |
Type: UpdateOfferDTO Параметры товара. Example
|
|
mapping |
Type: UpdateMappingDTO Информация о карточке товара на Маркете. Карточка на Маркете, которая, с вашей точки зрения, подходит товару. Чтобы определить идентификатор подходящей карточки, воспользуйтесь поиском в кабинете (Товары → Каталог → Загрузить товары). По результатам проверки Маркет может привязать товар к более подходящей карточке. Example
|
Example
{
"offer": {
"offerId": "example",
"name": "Ударная дрель Makita HP1630, 710 Вт",
"marketCategoryId": 0,
"category": "example",
"pictures": [
"example"
],
"videos": [
null
],
"manuals": [
{
"url": null,
"title": "example"
}
],
"vendor": "LEVENHUK",
"barcodes": [
"46012300000000"
],
"description": "example",
"manufacturerCountries": [
"Россия"
],
"weightDimensions": {
"length": 65.55,
"width": 50.7,
"height": 20,
"weight": 1.001
},
"vendorCode": "VNDR-0005A",
"tags": [
"до 500 рублей"
],
"shelfLife": {
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "example"
},
"lifeTime": null,
"guaranteePeriod": null,
"customsCommodityCode": "8517610008",
"commodityCodes": [
{
"code": "example",
"type": "CUSTOMS_COMMODITY_CODE"
}
],
"certificates": [
"example"
],
"boxCount": 1,
"condition": {
"type": "PREOWNED",
"quality": "PERFECT",
"reason": "example"
},
"type": "DEFAULT",
"downloadable": true,
"adult": true,
"age": {
"value": 0,
"ageUnit": "YEAR"
},
"params": [
{
"name": "Wi-Fi",
"value": "есть"
}
],
"parameterValues": [
{
"parameterId": 1,
"unitId": 0,
"valueId": 0,
"value": "example"
}
],
"basicPrice": {
"value": 0,
"currencyId": "RUR",
"discountBase": 0
},
"purchasePrice": null,
"additionalExpenses": null,
"firstVideoAsCover": true,
"deleteParameters": [
"ADDITIONAL_EXPENSES"
]
},
"mapping": {
"marketSku": 1
}
}
Responses
200 OK
Запрос выполнен корректно, данные обработаны.
Ответ 200 сам по себе не значит, что переданные значения корректны
Обязательно посмотрите детали ответа: status, а также перечень ошибок (results.errors) и замечаний (results.warnings), если они есть.
- Если хотя бы по одному товару вернулась ошибка (
results.errors), полеstatus=ERROR. Изменения по всем переданным товарам не будут применены. - Если ошибок нет, но хотя бы по одному товару вернулось замечание (
results.warnings), полеstatus=OK, и изменения будут применены.
Body
application/json
{
"status": "OK",
"results": [
{
"offerId": "example",
"errors": [
{}
],
"warnings": [
null
]
}
]
}
Type: object
All of 2 types
-
Type: ApiResponse
Стандартная обертка для ответов сервера.
Example
{ "status": "OK" } -
Type: object
results
Type: UpdateOfferMappingResultDTO[] | null
Ошибки и предупреждения, которые появились при обработке списка характеристик. Каждый элемент списка соответствует одному товару.
Если ошибок и предупреждений нет, поле не передается.
Min items:
1Example
[ { "offerId": "example", "errors": [ { "type": "UNKNOWN_CATEGORY", "parameterId": 0, "message": "example" } ], "warnings": [ null ] } ]Example
{ "results": [ { "offerId": "example", "errors": [ { "type": "UNKNOWN_CATEGORY", "parameterId": 0, "message": "example" } ], "warnings": [ null ] } ] }
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
Type: string
Enum: OK, ERROR
ApiResponse
Стандартная обертка для ответов сервера.
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
Example
{
"status": "OK"
}
OfferMappingErrorType
Типы ошибок и предупреждений:
UNKNOWN_CATEGORY— указана неизвестная категория.INVALID_CATEGORY— указана нелистовая категория. Укажите ту, которая не имеет дочерних категорий.EMPTY_MARKET_CATEGORY— не указана категория Маркета при передаче характеристик категории.UNKNOWN_PARAMETER— передана характеристика, которой нет среди характеристик категории.UNEXPECTED_BOOLEAN_VALUE— вместо boolean-значения передано что-то другое.NUMBER_FORMAT— передана строка, не обозначающая число, вместо числа.INVALID_UNIT_ID— передана единица измерения, недопустимая для характеристики.INVALID_GROUP_ID_LENGTH— в названии превышено допустимое значение символов — 255.INVALID_GROUP_ID_CHARACTERS— переданы недопустимые символы.INVALID_PICKER_URL— передана ссылка на изображение для миниатюры, которой нет в переданных ссылках на изображение товара.LOCKED_DIMENSIONS— переданы габариты упаковки, которые нельзя изменить.INVALID_COMMODITY_CODE— передан некорректный товарный код.
Проверить, какие категорийные характеристики доступны для заданной категории, и получить их настройки можно с помощью запроса POST v2/category/{categoryId}/parameters.
Type: string
Enum: UNKNOWN_CATEGORY, INVALID_CATEGORY, EMPTY_MARKET_CATEGORY, UNKNOWN_PARAMETER, UNEXPECTED_BOOLEAN_VALUE, NUMBER_FORMAT, INVALID_UNIT_ID, INVALID_GROUP_ID_LENGTH, INVALID_GROUP_ID_CHARACTERS, INVALID_PICKER_URL, LOCKED_DIMENSIONS, INVALID_COMMODITY_CODE
OfferMappingErrorDTO
Текст ошибки или предупреждения.
|
Name |
Description |
|
message |
Type: string Текст ошибки или предупреждения. Example: |
|
type |
Type: OfferMappingErrorType Типы ошибок и предупреждений:
Проверить, какие категорийные характеристики доступны для заданной категории, и получить их настройки можно с помощью запроса POST v2/category/{categoryId}/parameters. Enum: |
|
parameterId |
Type: integer Идентификатор характеристики, с которой связана ошибка или предупреждение. |
Example
{
"type": "UNKNOWN_CATEGORY",
"parameterId": 0,
"message": "example"
}
UpdateOfferMappingResultDTO
Ошибки и предупреждения, которые появились из-за переданных характеристик.
|
Name |
Description |
|
offerId |
Type: ShopSku Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Важно Пробельные символы в начале и конце значения автоматически удаляются. Например, Что такое SKU и как его назначать Min length: Max length: Pattern: Example: |
|
errors |
Type: OfferMappingErrorDTO[] | null Ошибки. Если хотя бы по одному товару есть ошибка, информация в каталоге не обновится по всем переданным товарам. Min items: Example
|
|
warnings |
Type: OfferMappingErrorDTO[] | null Предупреждения. Информация в каталоге обновится. Min items: Example
|
Example
{
"offerId": "example",
"errors": [
{
"type": "UNKNOWN_CATEGORY",
"parameterId": 0,
"message": "example"
}
],
"warnings": [
null
]
}
400 Bad Request
⚠️ Даже если проблема связана всего с одним товаром в запросе, в каталог не отправится ни один.
Запрос содержит неправильные данные. Подробнее об ошибках при работе с товарами и об ошибках при работе с ценами
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code |
Type: string Код ошибки. Example: |
|
message |
Type: string Описание ошибки. Example: |
Example
{
"code": "example",
"message": "example"
}
ApiErrorResponse
Стандартная обертка для ошибок сервера.
Type: object
All of 2 types
-
Type: ApiResponse
Стандартная обертка для ответов сервера.
Example
{ "status": "OK" } -
Type: object
errors
Type: ApiErrorDTO[] | null
Список ошибок.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
Example
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
423 Locked
К ресурсу нельзя применить указанный метод. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: ApiErrorResponse
Стандартная обертка для ошибок сервера.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] }
No longer supported, please use an alternative and newer version.
Что такое GTIN
GTIN — это уникальный номер, присвоенный товару в единой международной базе GS1. Из этого номера получается штрихкод формата EAN, UPC или ISBN.
Как убедиться, что товар есть в базе
Проверить код можно на странице проверки на сайте ассоциации GS1. Если товар не находится, запросите код GTIN у вашего поставщика.
Как получить GTIN для своих товаров
Чтобы получить коды GTIN, производителю нужно вступить в ассоциацию GS1 и зарегистрировать товары.
Запрещены ASCII символы с 0 по 31 (кроме 9) и 127 из таблицы.
Категории, у которых нет дочерних.