Добавление товаров в каталог и изменение информации о них

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Добавляет товары в каталог и передает:

  • их категории на Маркете и категорийные характеристики;
  • основные характеристики;
  • цены на товары в кабинете.

Также объединяет товары на карточке, редактирует и удаляет информацию об уже добавленных товарах, в том числе цены в кабинете и категории товаров.

Список категорий Маркета можно получить с помощью запроса POST categories/tree, а характеристики товаров по категориям с помощью POST category/{categoryId}/parameters.

Добавить новый товар

Передайте его с новым идентификатором, который раньше никогда не использовался в каталоге.

Обязательно укажите параметры: offerId, name, marketCategoryId, pictures, vendor, description.

Старайтесь сразу передать как можно больше информации — она потребуется Маркету для подбора подходящей карточки или создания новой.

Если известно, какой карточке на Маркете соответствует товар, можно сразу указать идентификатор этой карточки (SKU на Маркете) в поле marketSKU.

Для продавцов Market Yandex Go:

Когда вы добавляете товары в каталог, указывайте значения параметров name и description на русском языке. Чтобы на витрине они отображались и на другом языке, еще раз выполните запрос POST businesses/{businessId}/offer-mappings/update, где укажите:

  • язык в параметре language;
  • значения параметров name и description на указанном языке.

Повторно передавать остальные характеристики товара не нужно.

Изменить информацию о товаре

Передайте новые данные, указав в offerId соответствующий ваш SKU.

Поля, в которых ничего не меняется, можно не передавать.

Удалить переданные ранее параметры товара

В deleteParameters укажите значения параметров, которые хотите удалить. Можно передать сразу несколько значений.

Для параметров с типом string также можно передать пустое значение.

Параметр offerId должен быть уникальным для всех товаров, которые вы передаете.

Правила использования SKU

  • У каждого товара SKU должен быть свой.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Данные в каталоге обновляются не мгновенно

Это занимает до нескольких минут.

⚙️ Лимит: 10 000 товаров в минуту, не более 100 товаров в одном запросе

Request

POST

https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/update

Path parameters

Name

Description

businessId*

Type: integer<int64>

Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

language

Type: CatalogLanguageType

Язык, на котором принимаются и возвращаются значения в параметрах name и description.

Значение по умолчанию: RU.

CatalogLanguageType

Язык:

  • RU — русский.
  • UZ — узбекский.

Type

Description

CatalogLanguageType

Enum: RU, UZ

Body

application/json
{
    "offerMappings": [
        {
            "offer": {
                "offerId": "string",
                "name": "Ударная дрель Makita HP1630, 710 Вт",
                "marketCategoryId": 0,
                "category": "string",
                "pictures": [
                    "string"
                ],
                "videos": [
                    "string"
                ],
                "manuals": [
                    {
                        "url": "string",
                        "title": "string"
                    }
                ],
                "vendor": "LEVENHUK",
                "barcodes": [
                    46012300000000
                ],
                "description": "string",
                "manufacturerCountries": [
                    "Россия"
                ],
                "weightDimensions": {
                    "length": 65.55,
                    "width": 50.7,
                    "height": 20,
                    "weight": 1.001
                },
                "vendorCode": "VNDR-0005A",
                "tags": [
                    "до 500 рублей"
                ],
                "shelfLife": {
                    "timePeriod": 0,
                    "timeUnit": "HOUR",
                    "comment": "string"
                },
                "lifeTime": {
                    "timePeriod": 0,
                    "timeUnit": "HOUR",
                    "comment": "string"
                },
                "guaranteePeriod": {
                    "timePeriod": 0,
                    "timeUnit": "HOUR",
                    "comment": "string"
                },
                "customsCommodityCode": 8517610008,
                "commodityCodes": [
                    {
                        "code": "string",
                        "type": "CUSTOMS_COMMODITY_CODE"
                    }
                ],
                "certificates": [
                    "string"
                ],
                "boxCount": 0,
                "condition": {
                    "type": "PREOWNED",
                    "quality": "PERFECT",
                    "reason": "string"
                },
                "type": "DEFAULT",
                "downloadable": false,
                "adult": false,
                "age": {
                    "value": 0,
                    "ageUnit": "YEAR"
                },
                "params": [
                    {
                        "name": "Wi-Fi",
                        "value": "есть"
                    }
                ],
                "parameterValues": [
                    {
                        "parameterId": 0,
                        "unitId": 0,
                        "valueId": 0,
                        "value": "string"
                    }
                ],
                "basicPrice": {
                    "value": 0,
                    "currencyId": "RUR",
                    "discountBase": 0
                },
                "purchasePrice": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "additionalExpenses": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "cofinancePrice": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "firstVideoAsCover": false,
                "deleteParameters": [
                    "ADDITIONAL_EXPENSES"
                ]
            },
            "mapping": {
                "marketSku": 0
            }
        }
    ],
    "onlyPartnerMediaContent": false
}

Name

Description

offerMappings*

Type: UpdateOfferMappingDTO[]

Перечень товаров, которые нужно добавить или обновить.
Информация о товаре.

Min items: 1

Max items: 500

onlyPartnerMediaContent

Type: boolean

Будут ли использоваться только переданные вами данные о товарах.

Значение по умолчанию: false. Чтобы удалить данные, которые добавил Маркет, передайте значение true.

UpdateOfferMappingDTO

Информация о товаре.

Name

Description

offer*

Type: UpdateOfferDTO

Параметры товара.
Основные параметры товара.

mapping

Type: UpdateMappingDTO

Информация о карточке товара на Маркете.

UpdateOfferDTO

Параметры товара.

Name

Description

offerId*

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

additionalExpenses

Type: BasePriceDTO

Цена на товар.

adult

Type: boolean

Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей.

age

Type: AgeDTO

Если товар не предназначен для детей младше определенного возраста, укажите это.

Возрастное ограничение можно задавать в годах (с нуля, с 6, 12, 16 или 18) или в месяцах (любое число от 0 до 12).

barcodes

Type: string[]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN


Example: 46012300000000

Min items: 1

basicPrice

Type: UpdatePriceWithDiscountDTO

Цена с указанием скидки.
Цена на товар.

boxCount

Type: integer<int32>

Количество грузовых мест.

Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках.

Для товаров, занимающих одно место, не передавайте этот параметр.

category

⦸

Type: string

Этот параметр устарел

Вместо него используйте marketCategoryId.

Категория товара в вашем магазине.

certificates

Type: string[]

Номера документов на товар: сертификата, декларации соответствия и т. п.

Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции.

Min items: 1

cofinancePrice

⦸

Type: BasePriceDTO

Цена на товар.

commodityCodes

Type: CommodityCodeDTO[]

Товарные коды.
Товарный код.

Min items: 1

condition

Type: OfferConditionDTO

Состояние уцененного товара.

Используется только для товаров, продаваемых с уценкой.

Правила продажи уцененных товаров

customsCommodityCode

⦸

Type: string

Этот параметр устарел

Вместо него используйте commodityCodes с типом CUSTOMS_COMMODITY_CODE.

Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.

Обязательно укажите, если он есть.

Example: 8517610008

deleteParameters

Type: DeleteOfferParameterType[]

Параметры, которые вы ранее передали в UpdateOfferDTO, а теперь хотите удалить.

Если передать adult, downloadable и firstVideoAsCover, они не удалятся — их значение изменится на false.

Можно передать сразу несколько значений.

Не используйте вместе с соответствующим параметром в UpdateOfferDTO. Это приведет к ошибке 400.
Значения параметров, которые хотите удалить, и соответствующие параметры в UpdateOfferDTO, в которых вы передали эти значения ранее:

  • ADDITIONAL_EXPENSES — дополнительные расходы на товар (параметр additionalExpenses).
  • ADULT — пометка 18+ (параметр adult)
  • AGE — возрастное ограничение для детей (параметр age).
  • BARCODES — штрихкод (параметр barcodes).
  • BOX_COUNT — количество грузовых мест (параметр boxCount).
  • CERTIFICATES — номера документов на товар (параметр certificates).
  • COFINANCE_PRICE — цена для скидок с Маркетом (параметр cofinancePrice).
  • COMMODITY_CODES — товарные коды (параметр commodityCodes).
  • CONDITION — состояние уцененного товара (параметр condition).
  • CUSTOMS_COMMODITY_CODE — код товара в ТН ВЭД (параметр customsCommodityCode).
  • DESCRIPTION — описание товара (параметр description).
  • DOWNLOADABLE — признак цифрового товара (параметр downloadable).
  • FIRST_VIDEO_AS_COVER — использование первого видео в карточке как видеообложки (параметр firstVideoAsCover).
  • 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).

Enum: ADDITIONAL_EXPENSES, ADULT, AGE, BARCODES, BOX_COUNT, CERTIFICATES, COFINANCE_PRICE, COMMODITY_CODES, CONDITION, CUSTOMS_COMMODITY_CODE, DESCRIPTION, DOWNLOADABLE, FIRST_VIDEO_AS_COVER, GUARANTEE_PERIOD, LIFE_TIME, MANUALS, MANUFACTURER_COUNTRIES, PARAMETERS, PICTURES, PURCHASE_PRICE, SHELF_LIFE, TAGS, TYPE, VENDOR_CODE, VIDEOS

Min items: 1

Unique items  

description

Type: string

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов.

Рекомендации и правила

Max length: 6000

downloadable

Type: boolean

Признак цифрового товара. Укажите true, если товар доставляется по электронной почте.

Как работать с цифровыми товарами

firstVideoAsCover

Type: boolean

Использовать первое видео в карточке как видеообложку.

Передайте true, чтобы первое видео использовалось как видеообложка, или false, чтобы видеообложка не отображалась в карточке товара.

guaranteePeriod

Type: TimePeriodDTO

Гарантийный срок — период, в течение которого можно заменить или починить товар без дополнительной платы.

Обязательно указывайте срок, если он есть.

В комментарии опишите особенности гарантийного обслуживания. Например, Гарантия на аккумулятор — 6 месяцев.

lifeTime

Type: TimePeriodDTO

Срок службы — период, в течение которого товар должен исправно выполнять свою функцию.

Обязательно указывайте срок, если он есть.

В комментарии укажите условия хранения. Например, Использовать при температуре не ниже −10 градусов.

manuals

Type: OfferManualDTO[]

Список инструкций по использованию товара.

Максимальное количество инструкций — 6.
Инструкция по использованию товара.

Min items: 1

Max items: 6

manufacturerCountries

Type: string[]

Страна, где был произведен товар.

Записывайте названия стран так, как они записаны в списке.

Example: Россия

Min items: 1

marketCategoryId

Type: integer<int64>

Идентификатор категории на Маркете, к которой вы относите свой товар.

При изменении категории убедитесь, что характеристики товара и их значения в параметре parameterValues вы передаете для новой категории.

Список категорий Маркета можно получить с помощью запроса POST categories/tree.

name

Type: string

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов.

Рекомендации и правила

Example: Ударная дрель Makita HP1630, 710 Вт

Max length: 256

parameterValues

Type: ParameterValueDTO[]

Список характеристик с их значениями.

С parameterValues обязательно передавайте marketCategoryId — идентификатор категории на Маркете, к которой относятся указанные характеристики товара.

При изменении характеристик передавайте только те, значение которых нужно обновить. Если в marketCategoryId вы меняете категорию, значения общих характеристик для старой и новой категории сохранятся, передавать их не нужно.

Чтобы удалить значение заданной характеристики, передайте ее parameterId с пустым value.

Максимальное количество характеристик — 300.
Значение характеристики.

Вы можете указывать несколько значений одной характеристики при условии, что:

  • Тип характеристики — ENUM.
  • В ответе на запрос POST category/{categoryId}/parameters у данной характеристики поле multivalue имеет значение true.

Для этого в parameterValues передавайте каждое значение отдельно — несколько объектов с параметрами parameterId, valueId и value. Параметр parameterId должен быть одинаковым.

Min items: 1

Max items: 300

params

⦸

Type: OfferParamDTO[]

Этот параметр устарел

При передаче характеристик используйте parameterValues.

Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви.
Параметры товара.

Если у товара несколько значений одного параметра, передайте их с одним и тем же name, но разными value.

Пример
"params": [
  {
    "name": "Цвет для фильтра",
    "value": "Зеленый"
  },
  {
    "name": "Цвет для фильтра",
    "value": "Желтый"
  }
]

Min items: 1

pictures

Type: string[]

Ссылки на изображения товара. Изображение по первой ссылке считается основным, остальные дополнительными.

Требования к ссылкам

  • Ссылок может быть до 30.
  • Указывайте ссылку целиком, включая протокол http или https.
  • Максимальная длина — 512 символов.
  • Русские буквы в URL можно.
  • Можно использовать прямые ссылки на изображения и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.

✅ https://example-shop.ru/images/sku12345.jpg

✅ https://yadi.sk/i/NaBoRsimVOLov

❌ /images/sku12345.jpg

❌ https://www.dropbox.com/s/818f/tovar.jpg

Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.

Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится.

Требования к изображениям

Min items: 1

purchasePrice

Type: BasePriceDTO

Цена на товар.

shelfLife

Type: TimePeriodDTO

Срок годности — период, по прошествии которого товар становится непригоден.

Указывайте срок, указанный на банке или упаковке. Текущая дата, дата поставки или дата отгрузки значения не имеет.

Обязательно указывайте срок, если он есть.

В комментарии укажите условия хранения. Например, Хранить в сухом помещении.

tags

Type: string[]

Метки товара, которые использует магазин. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки.

Максимальная длина тега 20 символов. У одного товара может быть максимум 10 тегов. Всего можно создать не больше 50 разных тегов.

Example: до 500 рублей

Min items: 1

type

Type: OfferType

Особый тип товара. Указывается, если товар:

  • имеет особый тип, который хотите убрать;
  • лекарство;
  • бумажная или электронная книга;
  • аудиокнига;
  • музыка или видео;
  • изготовляется на заказ;
  • алкоголь.

Enum: DEFAULT, MEDICINE, BOOK, AUDIOBOOK, ARTIST_TITLE, ON_DEMAND, ALCOHOL

vendor

Type: string

Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.

Example: LEVENHUK

vendorCode

Type: string

Артикул товара от производителя.

Example: VNDR-0005A

videos

Type: string[]

Ссылки (URL) на видео товара.

Максимальное количество ссылок — 6.

Требования к ссылке

  • Указывайте ссылку целиком, включая протокол http или https.
  • Максимальная длина — 512 символов.
  • Русские буквы в URL можно.
  • Можно использовать прямые ссылки на видео и на Яндекс Диск. Ссылки на Яндекс Диске нужно копировать с помощью функции Поделиться. Относительные ссылки и ссылки на другие облачные хранилища — не работают.

✅ https://example-shop.ru/video/sku12345.avi

✅ https://yadi.sk/i/NaBoRsimVOLov

❌ /video/sku12345.avi

❌ https://www.dropbox.com/s/818f/super-tovar.avi

Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке.

Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится.

Требования к видео

Min items: 1

Max items: 6

weightDimensions

Type: OfferWeightDimensionsDTO

Габариты упаковки и вес товара.

UpdateMappingDTO

Карточка на Маркете, которая, с вашей точки зрения, подходит товару. Чтобы определить идентификатор подходящей карточки, воспользуйтесь поиском в кабинете (Товары → Каталог → Загрузить товары).

По результатам проверки Маркет может привязать товар к более подходящей карточке.

Name

Description

marketSku

Type: integer<int64>

Идентификатор карточки на Маркете.

Min value: 1

BasePriceDTO

Цена на товар.

Name

Description

currencyId*

Type: CurrencyType

Валюта.

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

value*

Type: number

Значение.

Min value (exclusive): 0

AgeDTO

Возраст в заданных единицах измерения.

Name

Description

ageUnit*

Type: AgeUnitType

Единица измерения.

Enum: YEAR, MONTH

value*

Type: number

Значение.

Min value: 0

UpdatePriceWithDiscountDTO

Цена с указанием скидки.

Name

Description

currencyId*

Type: CurrencyType

Валюта.

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

value*

Type: number

Значение.

Min value (exclusive): 0

discountBase

Type: number

Зачеркнутая цена.

Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%.

Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.

Min value (exclusive): 0

CommodityCodeDTO

Товарный код.

Name

Description

code*

Type: string

Товарный код.

type*

Type: CommodityCodeType

Тип товарного кода.

Enum: CUSTOMS_COMMODITY_CODE, IKPU_CODE

OfferConditionDTO

Состояние уцененного товара.

Name

Description

quality

Type: OfferConditionQualityType

Внешний вид товара.

Enum: PERFECT, EXCELLENT, GOOD, NOT_SPECIFIED

reason

Type: string

Описание товара. Подробно опишите дефекты, насколько они заметны и где их искать.

type

Type: OfferConditionType

Тип уценки.

Enum: PREOWNED, SHOWCASESAMPLE, REFURBISHED, REDUCTION, RENOVATED, NOT_SPECIFIED

DeleteOfferParameterType

Значения параметров, которые хотите удалить, и соответствующие параметры в UpdateOfferDTO, в которых вы передали эти значения ранее:

  • ADDITIONAL_EXPENSES — дополнительные расходы на товар (параметр additionalExpenses).
  • ADULT — пометка 18+ (параметр adult)
  • AGE — возрастное ограничение для детей (параметр age).
  • BARCODES — штрихкод (параметр barcodes).
  • BOX_COUNT — количество грузовых мест (параметр boxCount).
  • CERTIFICATES — номера документов на товар (параметр certificates).
  • COFINANCE_PRICE — цена для скидок с Маркетом (параметр cofinancePrice).
  • COMMODITY_CODES — товарные коды (параметр commodityCodes).
  • CONDITION — состояние уцененного товара (параметр condition).
  • CUSTOMS_COMMODITY_CODE — код товара в ТН ВЭД (параметр customsCommodityCode).
  • DESCRIPTION — описание товара (параметр description).
  • DOWNLOADABLE — признак цифрового товара (параметр downloadable).
  • FIRST_VIDEO_AS_COVER — использование первого видео в карточке как видеообложки (параметр firstVideoAsCover).
  • 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

Description

DeleteOfferParameterType

Enum: ADDITIONAL_EXPENSES, ADULT, AGE, BARCODES, BOX_COUNT, CERTIFICATES, COFINANCE_PRICE, COMMODITY_CODES, CONDITION, CUSTOMS_COMMODITY_CODE, DESCRIPTION, DOWNLOADABLE, FIRST_VIDEO_AS_COVER, GUARANTEE_PERIOD, LIFE_TIME, MANUALS, MANUFACTURER_COUNTRIES, PARAMETERS, PICTURES, PURCHASE_PRICE, SHELF_LIFE, TAGS, TYPE, VENDOR_CODE, VIDEOS

TimePeriodDTO

Временной отрезок с комментарием. Требования к содержанию комментария зависят от контекста использования параметра и указаны в описании поля, которое его содержит.

Name

Description

timePeriod*

Type: integer

Продолжительность в указанных единицах.

timeUnit*

Type: TimeUnitType

Единица измерения.

Enum: HOUR, DAY, WEEK, MONTH, YEAR

comment

Type: string

Комментарий.

OfferManualDTO

Инструкция по использованию товара.

Name

Description

url*

Type: string

Ссылка на инструкцию.

title

Type: string

Название инструкции, которое будет отображаться на карточке товара.

ParameterValueDTO

Значение характеристики.

Вы можете указывать несколько значений одной характеристики при условии, что:

  • Тип характеристики — ENUM.
  • В ответе на запрос POST category/{categoryId}/parameters у данной характеристики поле multivalue имеет значение true.

Для этого в parameterValues передавайте каждое значение отдельно — несколько объектов с параметрами parameterId, valueId и value. Параметр parameterId должен быть одинаковым.

Name

Description

parameterId*

Type: integer<int64>

Идентификатор характеристики.

Min value: 1

unitId

Type: integer<int64>

Идентификатор единицы измерения. Если вы не передали параметр unitId, используется единица измерения по умолчанию.

value

Type: string

Значение.

valueId

Type: integer<int64>

Идентификатор значения.

Обязательно указывайте идентификатор, если передаете значение из перечня допустимых значений, полученного от Маркета.

Только для характеристик типа ENUM.

OfferParamDTO

Параметры товара.

Если у товара несколько значений одного параметра, передайте их с одним и тем же name, но разными value.

Пример
"params": [
  {
    "name": "Цвет для фильтра",
    "value": "Зеленый"
  },
  {
    "name": "Цвет для фильтра",
    "value": "Желтый"
  }
]

Name

Description

name*

Type: string

Название.

Должно совпадать с названием характеристики на Маркете. Узнать его можно из Excel-шаблона категории или через запрос POST category/{categoryId}/parameters.

Example: Wi-Fi

value*

Type: string

Значение.

Example: есть

OfferType

Особый тип товара:

  • DEFAULT — товары, для которых вы передавали особый тип ранее и хотите убрать его.
  • MEDICINE — лекарства.
  • BOOK — бумажные и электронные книги.
  • AUDIOBOOK — аудиокниги.
  • ARTIST_TITLE — музыкальная и видеопродукция.
  • ON_DEMAND — товары на заказ.
  • ALCOHOL — алкоголь.

Если ваш товар — книга

Укажите год издания в характеристиках товара. Подробнее о параметре

Type

Description

OfferType

Enum: DEFAULT, MEDICINE, BOOK, AUDIOBOOK, ARTIST_TITLE, ON_DEMAND, ALCOHOL

OfferWeightDimensionsDTO

Габариты упаковки и вес товара.

Если товар занимает несколько коробок, перед измерением размеров сложите их компактно.

Схема измерения многоместных грузов

Name

Description

height*

Type: number

Высота упаковки в см.

Example: 20

length*

Type: number

Длина упаковки в см.

Example: 65.55

weight*

Type: number

Вес товара в кг с учетом упаковки (брутто).

Example: 1.001

width*

Type: number

Ширина упаковки в см.

Example: 50.7

CurrencyType

Коды валют. Возможные значения:

  • RUR — российский рубль.
  • UAH — украинская гривна.
  • BYR — белорусский рубль.
  • KZT — казахстанский тенге.
  • UZS — узбекский сум.

Type

Description

CurrencyType

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

AgeUnitType

Единицы измерения возраста:

  • YEAR — год.
  • MONTH — месяц.

Type

Description

AgeUnitType

Enum: YEAR, MONTH

CommodityCodeType

Тип товарного кода:

  • CUSTOMS_COMMODITY_CODE — код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов.
  • IKPU_CODE — идентификационный код продукции и услуг (ИКПУ) в Узбекистане – 17 цифр без пробелов.

Не передавайте несколько кодов одного типа.

Type

Description

CommodityCodeType

Enum: CUSTOMS_COMMODITY_CODE, IKPU_CODE

OfferConditionQualityType

Внешний вид товара:

  • PERFECT — идеальный.
  • EXCELLENT — отличный.
  • GOOD — хороший.
  • NOT_SPECIFIED — не выбран.

Type

Description

OfferConditionQualityType

Enum: PERFECT, EXCELLENT, GOOD, NOT_SPECIFIED

OfferConditionType

Тип уценки:

  • PREOWNED — бывший в употреблении товар, раньше принадлежал другому человеку.
  • SHOWCASESAMPLE — витринный образец.
  • REFURBISHED — повторная продажа товара.
  • REDUCTION — товар с дефектами.
  • RENOVATED — восстановленный товар.
  • NOT_SPECIFIED — не выбран.

REFURBISHED — специальное значение для одежды, обуви и аксессуаров. Используется только для уцененных товаров из этой категории. Другие значения для одежды, обуви и аксессуаров не используются.

Type

Description

OfferConditionType

Enum: PREOWNED, SHOWCASESAMPLE, REFURBISHED, REDUCTION, RENOVATED, NOT_SPECIFIED

TimeUnitType

Единица измерения времени:

  • HOUR — час.
  • DAY — сутки.
  • WEEK — неделя.
  • MONTH — месяц.
  • YEAR — год.

Type

Description

TimeUnitType

Enum: HOUR, DAY, WEEK, MONTH, YEAR

Responses

200 OK

Запрос выполнен корректно, данные обработаны.

Ответ 200 сам по себе не значит, что переданные значения корректны

Обязательно посмотрите детали ответа: status и перечень ошибок, если он есть.

Даже если ошибка допущена в характеристиках всего одного товара, никакие изменения из запроса в каталог не попадут.

Body

application/json
{
    "status": "OK",
    "results": [
        {
            "offerId": "string",
            "errors": [
                {
                    "type": "UNKNOWN_CATEGORY",
                    "parameterId": 0,
                    "message": "string"
                }
            ],
            "warnings": [
                {
                    "type": "UNKNOWN_CATEGORY",
                    "parameterId": 0,
                    "message": "string"
                }
            ]
        }
    ]
}

Name

Description

results

Type: UpdateOfferMappingResultDTO[]

Ошибки и предупреждения, которые появились при обработке списка характеристик. Каждый элемент списка соответствует одному товару.

Если ошибок и предупреждений нет, поле не передается.
Ошибки и предупреждения, которые появились из-за переданных характеристик.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

UpdateOfferMappingResultDTO

Ошибки и предупреждения, которые появились из-за переданных характеристик.

Name

Description

offerId*

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

errors

Type: OfferMappingErrorDTO[]

Ошибки.

Если хотя бы по одному товару есть ошибка, информация в каталоге не обновится по всем переданным товарам.
Текст ошибки или предупреждения.

Min items: 1

warnings

Type: OfferMappingErrorDTO[]

Предупреждения.

Информация в каталоге обновится.
Текст ошибки или предупреждения.

Min items: 1

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OfferMappingErrorDTO

Текст ошибки или предупреждения.

Name

Description

message*

Type: string

Текст ошибки или предупреждения.

type*

Type: 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 category/{categoryId}/parameters.

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

parameterId

Type: integer<int64>

Идентификатор характеристики, с которой связана ошибка или предупреждение.

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 category/{categoryId}/parameters.

Type

Description

OfferMappingErrorType

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

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

423 Locked

К ресурсу нельзя применить указанный метод.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Предыдущая
Списки характеристик товаров по категориям
Следующая
Лимит на установку кванта и минимального количества товаров