- Request
- Responses
- 200 OK
- Body
- ApiResponseStatusType
- GetOfferMappingsResultDTO
- ScrollingPagerDTO
- GetOfferMappingDTO
- GetOfferDTO
- GetMappingDTO
- OfferManualDTO
- OfferWeightDimensionsDTO
- TimePeriodDTO
- OfferConditionDTO
- OfferType
- AgeDTO
- OfferParamDTO
- GetPriceWithDiscountDTO
- GetPriceDTO
- OfferCampaignStatusDTO
- OfferSellingProgramDTO
- TimeUnitType
- OfferConditionType
- OfferConditionQualityType
- AgeUnitType
- CurrencyType
- OfferCampaignStatusType
- SellingProgramType
- OfferSellingProgramStatusType
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 500 Internal Server Error
Информация о товарах в каталоге
Возвращает список товаров в каталоге с параметрами каждого товара.
Можно использовать тремя способами:
- задать список интересующих SKU;
- задать фильтр — в этом случае результаты возвращаются постранично;
- не передавать тело запроса, чтобы получить список всех товаров в каталоге.
| ⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе |
|---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings
Path parameters
|
Name |
Type |
Description |
|
businessId* |
integer<int64> |
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. |
Query parameters
|
Name |
Type |
Description |
|
page_token |
string |
Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра Если задан |
|
limit |
integer<int32> |
Количество товаров на одной странице.
|
Body
{
"offerIds": [
"string"
],
"cardStatuses": [
"HAS_CARD_CAN_NOT_UPDATE"
],
"categoryIds": [
0
],
"vendorNames": [
"string"
],
"tags": [
"string"
],
"archived": false
}
|
Name |
Type |
Description |
|
offerIds |
string[] |
Идентификаторы товаров, информация о которых нужна. Такой список возвращается только целиком Если вы запрашиваете информацию по конкретным SKU, не заполняйте:
Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы Правила использования SKU:
Что такое SKU и как его назначать
|
|
cardStatuses |
Фильтр по статусам карточек. Что такое карточка товара
Что обозначает каждый из статусов
|
|
|
categoryIds |
integer[] |
Фильтр по категориям на Маркете. |
|
vendorNames |
string[] |
Фильтр по брендам. |
|
tags |
string[] |
Фильтр по тегам. |
|
archived |
boolean |
Фильтр по нахождению в архиве. Передайте |
OfferCardStatusType
Статус карточки товара:
- HAS_CARD_CAN_NOT_UPDATE — Карточка Маркета.
- HAS_CARD_CAN_UPDATE — Можно дополнить.
- HAS_CARD_CAN_UPDATE_ERRORS — Изменения не приняты.
- HAS_CARD_CAN_UPDATE_PROCESSING — Изменения на проверке.
- NO_CARD_NEED_CONTENT — Создайте карточку.
- NO_CARD_MARKET_WILL_CREATE — Создаст Маркет.
- NO_CARD_ERRORS — Не создана из-за ошибки.
- NO_CARD_PROCESSING — Проверяем данные.
- NO_CARD_ADD_TO_CAMPAIGN — Разместите товар в магазине.
Что обозначает каждый из статусов
|
Type |
Description |
|
Enum: |
Responses
200 OK
Информация о товарах в каталоге.
Body
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"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,
"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": "есть"
}
],
"basicPrice": {
"value": 0,
"currencyId": "RUR",
"discountBase": 0,
"updatedAt": "2022-12-29T18:02:01Z"
},
"purchasePrice": {
"value": 0,
"currencyId": "RUR",
"updatedAt": "2022-12-29T18:02:01Z"
},
"additionalExpenses": {
"value": 0,
"currencyId": "RUR",
"updatedAt": "2022-12-29T18:02:01Z"
},
"cofinancePrice": {
"value": 0,
"currencyId": "RUR",
"updatedAt": "2022-12-29T18:02:01Z"
},
"cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
"campaigns": [
{
"campaignId": 0,
"status": "PUBLISHED"
}
],
"sellingPrograms": [
{
"sellingProgram": "FBY",
"status": "FINE"
}
],
"archived": false
},
"mapping": {
"marketSku": 0,
"marketSkuName": "string",
"marketModelId": 0,
"marketModelName": "string",
"marketCategoryId": 0,
"marketCategoryName": "string"
}
}
]
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Информация о товарах. |
GetOfferMappingsResultDTO
Информация о товарах.
|
Name |
Type |
Description |
|
paging |
Ссылка на следующую страницу. |
|
|
offerMappings |
Информация о товарах. |
ScrollingPagerDTO
Информация о страницах результатов.
|
Name |
Type |
Description |
|
nextPageToken |
string |
Идентификатор следующей страницы результатов. |
|
prevPageToken |
string |
Идентификатор предыдущей страницы результатов. |
GetOfferMappingDTO
Информация о товаре.
|
Name |
Type |
Description |
|
offer |
Основные параметры товара. |
|
|
mapping |
Информация о карточке товара на Маркете. Может отсутствовать в ответе, если товар еще не привязан к карточке. Проверьте статус карточки или исправьте ошибки. |
GetOfferDTO
Параметры товара.
|
Name |
Type |
Description |
|
offerId* |
string |
Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы Правила использования SKU:
Что такое SKU и как его назначать
|
|
name |
string |
Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке. Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей. Оптимальная длина — 50–60 символов, максимальная — 256.
|
|
marketCategoryId |
integer<int64> |
Идентификатор категории на Маркете, к которой вы относите свой товар. Если не указать Список категорий Маркета можно получить с помощью запроса POST categories/tree. |
|
category |
string |
Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId. Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда. Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре |
|
pictures |
string[] |
Ссылки на изображения товара. Изображение по первой ссылке считается основным, остальные дополнительными. Требования к ссылкам
✅ ✅ ❌ ❌ Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке. Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится. |
|
videos |
string[] |
Ссылка (URL) на видео товара. Максимальное количество ссылок — 6. Требования к ссылке
✅ ✅ ❌ ❌ Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке. Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится. |
|
manuals |
Список инструкций по использованию товара. Максимальное количество инструкций — 6. Если вы передадите пустое поле |
|
|
vendor |
string |
Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
|
|
barcodes |
string[] |
Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128. Для книг указывайте ISBN. Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN. Что такое GTIN
|
|
description |
string |
Подробное описание товара: например, его преимущества и особенности. Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок. Можно использовать теги:
Оптимальная длина — 400–600 символов, максимальная — 6000.
|
|
manufacturerCountries |
string[] |
Страна, где был произведен товар. Записывайте названия стран так, как они записаны в списке.
|
|
weightDimensions |
Габариты упаковки и вес товара. |
|
|
vendorCode |
string |
Артикул товара от производителя.
|
|
tags |
string[] |
Метки товара, используемые магазином. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки. Максимальная длина тега 20 символов. У одного товара может быть максимум 10 тегов. Всего можно создать не больше 50 разных тегов.
|
|
shelfLife |
Срок годности — период, по прошествии которого товар становится непригоден. Указывайте срок, указанный на банке или упаковке. Текущая дата, дата поставки или дата отгрузки значения не имеет. Обязательно указывайте срок, если он есть. В комментарии укажите условия хранения. Например, «Хранить в сухом помещении». |
|
|
lifeTime |
Срок службы — период, в течение которого товар должен исправно выполнять свою функцию. Обязательно указывайте срок, если он есть. В комментарии укажите условия хранения. Например, «Использовать при температуре не ниже −10 градусов». |
|
|
guaranteePeriod |
Гарантийный срок — период, в течение которого можно бесплатно заменить или починить товар. Обязательно указывайте срок, если он есть. В комментарии опишите особенности гарантийного обслуживания. Например, «Гарантия на аккумулятор — 6 месяцев». |
|
|
customsCommodityCode |
string |
Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов. Обязательно укажите, если он есть.
|
|
certificates |
string[] |
Номера документов на товар: сертификата, декларации соответствия и т. п. Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции.
|
|
boxCount |
integer<int32> |
Количество грузовых мест. Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках. Для товаров, занимающих одно место, не передавайте этот параметр. |
|
condition |
Состояние уцененного товара. Используется только для товаров, продаваемых с уценкой. |
|
|
type |
Особый тип товара. Указывается, если товар:
|
|
|
downloadable |
boolean |
Признак цифрового товара. Укажите |
|
adult |
boolean |
Параметр включает для товара пометку 18+. Устанавливайте ее только для товаров, которые относятся к удовлетворению сексуальных потребностей. |
|
age |
Если товар не предназначен для детей младше определенного возраста, укажите это. Возрастное ограничение можно задавать в годах (с нуля, с 6, 12, 16 или 18) или в месяцах (любое число от 0 до 12). |
|
|
params |
Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви. Используйте POST businesses/{businessId}/offer-cards/update для передачи характеристик товара, которые специфичны для его категории. Так переданные характеристики с большей вероятностью попадут на карточку. |
|
|
basicPrice |
Цена.
|
|
|
purchasePrice |
Себестоимость — затраты на самостоятельное производство товара или закупку у производителя или поставщиков.
|
|
|
additionalExpenses |
Дополнительные расходы на товар. Например, на доставку или упаковку.
|
|
|
cofinancePrice |
Цена для скидок с Маркетом Маркет может компенсировать до половины скидки. Назначьте минимальную цену до вычета тарифов, по которой готовы продавать товар, а мы рассчитаем скидку и размер софинансирования. Если Маркет не готов софинансировать скидку, покупатель ее не увидит.
|
|
|
cardStatus |
Статус карточки товара.
|
|
|
campaigns |
Список магазинов, в которых размещен товар.
|
|
|
sellingPrograms |
Информация о том, какие для товара доступны модели размещения.
|
|
|
archived |
boolean |
Товар помещен в архив. |
GetMappingDTO
Информация о товарах в каталоге.
|
Name |
Type |
Description |
|
marketSku |
integer<int64> |
Идентификатор карточки на Маркете. |
|
marketSkuName |
string |
Название карточки товара. Может отсутствовать в ответе, если товар еще не привязан к карточке. |
|
marketModelId |
integer<int64> |
Идентификатор модели на Маркете. Может отсутствовать в ответе, если товар еще не привязан к карточке. |
|
marketModelName |
string |
Название модели на Маркете. Может отсутствовать в ответе, если товар еще не привязан к карточке. |
|
marketCategoryId |
integer<int64> |
Идентификатор категории карточки на Маркете. Может отсутствовать в ответе, если Маркет еще не определил категорию товара. |
|
marketCategoryName |
string |
Название категории карточки на Маркете. Может отсутствовать в ответе, если Маркет еще не определил категорию товара. |
OfferManualDTO
Инструкция по использованию товара.
|
Name |
Type |
Description |
|
url* |
string |
Ссылка на инструкцию. |
|
title |
string |
Название инструкции, которое будет отображаться на карточке товара. |
OfferWeightDimensionsDTO
Габариты упаковки и вес товара.
Если товар занимает несколько коробок, перед измерением размеров сложите их компактно.
|
Name |
Type |
Description |
|
length* |
number |
Длина упаковки в см.
|
|
width* |
number |
Ширина упаковки в см.
|
|
height* |
number |
Высота упаковки в см.
|
|
weight* |
number |
Вес товара в кг с учетом упаковки (брутто).
|
TimePeriodDTO
Временной отрезок с комментарием. Требования к содержанию комментария зависят от контекста использования параметра и указаны в описании поля, которое его содержит.
|
Name |
Type |
Description |
|
timePeriod* |
integer |
Продолжительность в указанных единицах. |
|
timeUnit* |
Единица измерения.
|
|
|
comment |
string |
Комментарий. |
OfferConditionDTO
Состояние уцененного товара.
|
Name |
Type |
Description |
|
type |
Тип уценки.
|
|
|
quality |
Внешний вид товара.
|
|
|
reason |
string |
Описание товара. Подробно опишите дефекты, насколько они заметны и где их искать. |
OfferType
Особый тип товара:
MEDICINE— лекарства.BOOK— бумажные и электронные книги.AUDIOBOOK— аудиокниги.ARTIST_TITLE— музыкальная и видеопродукция.ON_DEMAND— товары на заказ.
Если ваш товар — книга
Укажите год издания в характеристиках товара. Подробнее о параметре
|
Type |
Description |
|
Enum: |
AgeDTO
Возраст в заданных единицах измерения.
|
Name |
Type |
Description |
|
value* |
number |
Значение. |
|
ageUnit* |
Единица измерения.
|
OfferParamDTO
Параметры товара.
Используйте POST businesses/{businessId}/offer-cards/update для передачи характеристик товара, которые специфичны для его категории. Так переданные характеристики с большей вероятностью попадут на карточку.
|
Name |
Type |
Description |
|
name* |
string |
Название. Должно совпадать с названием характеристики на Маркете. Узнать его можно из Excel-шаблона категории или через запрос POST category/{categoryId}/parameters.
|
|
value* |
string |
Значение.
|
GetPriceWithDiscountDTO
Цена с указанием скидки и времени последнего обновления.
|
Name |
Type |
Description |
|
value |
number |
Значение. |
|
currencyId |
Валюта. Если
|
|
|
discountBase |
number |
Цена до скидки. Число должно быть целым. Вы можете указать цену со скидкой от 5 до 75%. Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар. |
|
updatedAt* |
string<date-time> |
Время последнего обновления. |
GetPriceDTO
Цена с указанием времени последнего обновления.
|
Name |
Type |
Description |
|
value* |
number |
Значение. |
|
currencyId* |
Валюта. Если
|
|
|
updatedAt* |
string<date-time> |
Время последнего обновления. |
OfferCampaignStatusDTO
Статус товара в магазине.
|
Name |
Type |
Description |
|
campaignId* |
integer<int64> |
Идентификатор кампании. |
|
status* |
Статус товара.
|
OfferSellingProgramDTO
Информация о том, по каким моделям можно продавать товар, а по каким нельзя.
|
Name |
Type |
Description |
|
sellingProgram* |
Модель размещения.
|
|
|
status* |
Информация о том, можно ли по этой модели продавать товар.
|
TimeUnitType
Единица измерения времени:
HOUR— час;DAY— сутки;WEEK— неделя;MONTH— месяц;YEAR— год.
|
Type |
Description |
|
Enum: |
OfferConditionType
Тип уценки:
PREOWNED— бывший в употреблении товар, раньше принадлежал другому человеку.SHOWCASESAMPLE— витринный образец.REFURBISHED— повторная продажа товара.REDUCTION— товар с дефектами.RENOVATED— восстановленный товар.NOT_SPECIFIED— не выбран.
REFURBISHED — специальное значение для одежды, обуви и аксессуаров. Используется только для уцененных товаров из этой категории. Другие значения для одежды, обуви и аксессуаров не используются.
|
Type |
Description |
|
Enum: |
OfferConditionQualityType
Внешний вид товара:
PERFECT— идеальный.EXCELLENT— отличный.GOOD— хороший.NOT_SPECIFIED— не выбран.
|
Type |
Description |
|
Enum: |
AgeUnitType
Единицы измерения возраста:
YEAR— год.MONTH— месяц.
|
Type |
Description |
|
Enum: |
CurrencyType
Коды валют. Возможные значения:
BYR— белорусский рубль.KZT— казахстанский тенге.RUR— российский рубль.UAH— украинская гривна.
|
Type |
Description |
|
Enum: |
OfferCampaignStatusType
Статус товара:
PUBLISHED— Готов к продаже.CHECKING— На проверке.DISABLED_BY_PARTNER— Скрыт вами.REJECTED_BY_MARKET— Отклонен.DISABLED_AUTOMATICALLY— Исправьте ошибки.CREATING_CARD— Создается карточка.NO_CARD— Нужна карточка.NO_STOCKS— Нет на складе.
Что обозначает каждый из статусов
|
Type |
Description |
|
Enum: |
SellingProgramType
Модель размещения:
FBY— FBY.FBS— FBS.DBS— DBS.EXPRESS— Экспресс.
|
Type |
Description |
|
Enum: |
OfferSellingProgramStatusType
Информация о доступности или недоступности.
FINE— доступно.REJECT— недоступно.
|
Type |
Description |
|
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
Что такое GTIN
GTIN — это уникальный номер, присвоенный товару в единой международной базе GS1. Из этого номера получается штрихкод формата EAN, UPC или ISBN.
Как убедиться, что товар есть в базе
Проверить код можно на странице проверки на сайте ассоциации GS1. Если товар не находится, запросите код GTIN у вашего поставщика.
Как получить GTIN для своих товаров
Чтобы получить коды GTIN, производителю нужно вступить в ассоциацию GS1 и зарегистрировать товары.