Информация о товарах в каталоге

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

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

Возвращает список товаров в каталоге, их категории на Маркете и характеристики каждого товара.

Можно использовать тремя способами:

  • задать список интересующих SKU;
  • задать фильтр — в этом случае результаты возвращаются постранично;
  • не передавать тело запроса, чтобы получить список всех товаров в каталоге.
⚙️ Лимит: 600 запросов в минуту, не более 200 товаров в одном запросе

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

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

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

Min value: 1

Query parameters

Name

Description

language

Type: CatalogLanguageType

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

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

limit

Type: integer<int32>

Количество значений на одной странице.

Min value: 1
Example: 20

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуем передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

CatalogLanguageType

Язык:

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

Type

Description

CatalogLanguageType

Enum: RU, UZ

Body

application/json
{
    "offerIds": [
        "string"
    ],
    "cardStatuses": [
        "HAS_CARD_CAN_NOT_UPDATE"
    ],
    "categoryIds": [
        0
    ],
    "vendorNames": [
        "string"
    ],
    "tags": [
        "string"
    ],
    "archived": false
}

Name

Description

archived

Type: boolean

Фильтр по нахождению в архиве.

Передайте true, чтобы получить товары, находящиеся в архиве. Если фильтр не заполнен или передано false, в ответе возвращаются товары, не находящиеся в архиве.

cardStatuses

Type: 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 — Разместите товар в магазине.

Enum: 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

Min items: 1

Unique items  

categoryIds

Type: integer[]

Фильтр по категориям на Маркете.

Min items: 1

Unique items  

offerIds

Type: string[]

Идентификаторы товаров, информация о которых нужна.

Такой список возвращается только целиком

Если вы запрашиваете информацию по конкретным SKU, не заполняйте:

  • page_token;
  • limit;
  • cardStatuses;
  • categoryIds;
  • vendorNames;
  • tags;
  • archived.


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

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

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

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

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

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

Min length: 1

Max length: 255

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

Min items: 1

Max items: 200

Unique items  

tags

Type: string[]

Фильтр по тегам.

Min items: 1

Unique items  

vendorNames

Type: string[]

Фильтр по брендам.

Min items: 1

Unique items  

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

OfferCardStatusType

Enum: 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

Responses

200 OK

Информация о товарах в каталоге.

Body

application/json
{
    "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,
                    "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": "есть"
                        }
                    ],
                    "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"
                    },
                    "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
                    "campaigns": [
                        {
                            "campaignId": 0,
                            "status": "PUBLISHED"
                        }
                    ],
                    "sellingPrograms": [
                        {
                            "sellingProgram": "FBY",
                            "status": "FINE"
                        }
                    ],
                    "mediaFiles": {
                        "firstVideoAsCover": false,
                        "videos": [
                            {
                                "url": "string",
                                "title": "string",
                                "uploadState": "UPLOADING"
                            }
                        ],
                        "pictures": [
                            {
                                "url": "string",
                                "title": "string",
                                "uploadState": "UPLOADING"
                            }
                        ],
                        "manuals": [
                            {
                                "url": "string",
                                "title": "string",
                                "uploadState": "UPLOADING"
                            }
                        ]
                    },
                    "archived": false
                },
                "mapping": {
                    "marketSku": 0,
                    "marketSkuName": "string",
                    "marketModelId": 0,
                    "marketModelName": "string",
                    "marketCategoryId": 0,
                    "marketCategoryName": "string"
                },
                "showcaseUrls": [
                    {
                        "showcaseType": "B2B",
                        "showcaseUrl": "string"
                    }
                ]
            }
        ]
    }
}

Name

Description

result

Type: GetOfferMappingsResultDTO

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

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

GetOfferMappingsResultDTO

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

Name

Description

offerMappings*

Type: GetOfferMappingDTO[]

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

paging

Type: ScrollingPagerDTO

Идентификатор следующей страницы.
Идентификатор следующей страницы.

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetOfferMappingDTO

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

Name

Description

mapping

Type: GetMappingDTO

Информация о карточке товара на Маркете.
Идентификатор карточки на Маркете. Показывает текущую привязку товара к карточке.

Может отсутствовать в ответе, если товар еще не привязан к карточке. Проверьте статус карточки или исправьте ошибки.

offer

Type: GetOfferDTO

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

showcaseUrls

Type: ShowcaseUrlDTO[]

Ссылки на один и тот же товар на разных витринах Маркета.
Ссылка на товар на витрине и ее тип.

Min items: 1

ScrollingPagerDTO

Информация о страницах результатов.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

prevPageToken

Type: string

Идентификатор предыдущей страницы результатов.

GetMappingDTO

Информация о товарах в каталоге.

Name

Description

marketCategoryId

Type: integer<int64>

Идентификатор категории на Маркете, в которую попал товар.

Может отсутствовать в ответе, если Маркет еще не определил категорию товара.

marketCategoryName

Type: string

Название категории карточки на Маркете.

Может отсутствовать в ответе, если Маркет еще не определил категорию товара.

marketModelId

⦸

Type: integer<int64>

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

Может отсутствовать в ответе, если товар еще не привязан к карточке.

marketModelName

⦸

Type: string

Название модели на Маркете.

Может отсутствовать в ответе, если товар еще не привязан к карточке.

marketSku

Type: integer<int64>

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

Min value: 1

marketSkuName

Type: string

Название карточки товара.

Может отсутствовать в ответе, если товар еще не привязан к карточке.

GetOfferDTO

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

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: GetPriceDTO

Дополнительные расходы на товар. Например, на доставку или упаковку.
Цена на товар.
Время последнего обновления.

adult

Type: boolean

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

age

Type: AgeDTO

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

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

archived

Type: boolean

Товар помещен в архив.

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

Unique items  

basicPrice

Type: GetPriceWithDiscountDTO

Цена.
Цена с указанием скидки.
Время последнего обновления.

boxCount

Type: integer<int32>

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

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

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

Min value: 1

campaigns

Type: OfferCampaignStatusDTO[]

Список магазинов, в которых размещен товар.
Статус товара в магазине.

Min items: 1

cardStatus

Type: 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 — Разместите товар в магазине.

Enum: 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

category

⦸

Type: string

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

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

certificates

Type: string[]

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

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

Min items: 1

Unique items  

commodityCodes

Type: CommodityCodeDTO[]

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

Min items: 1

condition

Type: OfferConditionDTO

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

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

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

customsCommodityCode

⦸

Type: string

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

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

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

Example: 8517610008

description

Type: string

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

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

Для форматирования текста можно использовать теги HTML:

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

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

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

downloadable

Type: boolean

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

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

guaranteePeriod

Type: TimePeriodDTO

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

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

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

lifeTime

Type: TimePeriodDTO

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

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

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

manuals

Type: OfferManualDTO[]

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

Min items: 1

manufacturerCountries

Type: string[]

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

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

Example: Россия

Min items: 1

Unique items  

marketCategoryId

Type: integer<int64>

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

Всегда указывайте, когда передаете parameterValues

Если при изменении характеристик передать parameterValues и не указать marketCategoryId, характеристики обновятся, но в ответе придет предупреждение (параметр warnings).

Если не передать их оба, будет использована информация из устаревших параметров params и category, а marketCategoryId будет определен автоматически.

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

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

mediaFiles

Type: OfferMediaFilesDTO

Информация о медиафайлах товара.

name

Type: string

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

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

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

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

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

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 length: 1

Max length: 2000

Min items: 1

Unique items false

purchasePrice

Type: GetPriceDTO

Себестоимость — затраты на самостоятельное производство товара или закупку у производителя или поставщиков.
Цена на товар.
Время последнего обновления.

sellingPrograms

Type: OfferSellingProgramDTO[]

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

Min items: 1

shelfLife

Type: TimePeriodDTO

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

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

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

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

tags

Type: string[]

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

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

Example: до 500 рублей

Min items: 1

Max items: 50

Unique items  

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) на видео товара.

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

  • Указывайте ссылку целиком, включая протокол 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 length: 1

Max length: 2000

Min items: 1

Unique items false

weightDimensions

Type: OfferWeightDimensionsDTO

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

ShowcaseUrlDTO

Ссылка на товар на витрине и ее тип.

Name

Description

showcaseType*

Type: ShowcaseType

Тип витрины.

Enum: B2B, B2C

showcaseUrl*

Type: string

Ссылка на товар.

GetPriceDTO

Цена с указанием времени последнего обновления.

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

updatedAt*

Type: string<date-time>

Время последнего обновления.

value*

Type: number

Цена товара.

Min value (exclusive): 0

AgeDTO

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

Name

Description

ageUnit*

Type: AgeUnitType

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

Enum: YEAR, MONTH

value*

Type: number

Значение.

Min value: 0

GetPriceWithDiscountDTO

Цена с указанием валюты, скидки и времени последнего обновления.

Name

Description

updatedAt*

Type: string<date-time>

Время последнего обновления.

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

discountBase

Type: number

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

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

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

Min value (exclusive): 0

value

Type: number

Цена товара.

Min value (exclusive): 0

OfferCampaignStatusDTO

Статус товара в магазине.

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании.

Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:

  • Модули и API → блок Передача данных Маркету.
  • Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

status*

Type: OfferCampaignStatusType

Статус товара.

Enum: PUBLISHED, CHECKING, DISABLED_BY_PARTNER, DISABLED_AUTOMATICALLY, REJECTED_BY_MARKET, CREATING_CARD, NO_CARD, NO_STOCKS, ARCHIVED

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

TimePeriodDTO

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

Name

Description

timePeriod*

Type: integer

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

timeUnit*

Type: TimeUnitType

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

Enum: HOUR, DAY, WEEK, MONTH, YEAR

comment

Type: string

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

Max length: 500

OfferManualDTO

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

Name

Description

url*

Type: string

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

Min length: 1

Max length: 2000

title

Type: string

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

Max length: 500

OfferMediaFilesDTO

Информация о медиафайлах товара.

Name

Description

firstVideoAsCover

⦸

Type: boolean

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

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

manuals

Type: OfferMediaFileDTO[]

Руководства по использованию товара.
Информация о медиафайле товара.

Min items: 1

pictures

Type: OfferMediaFileDTO[]

Изображения товара.
Информация о медиафайле товара.

Min items: 1

videos

Type: OfferMediaFileDTO[]

Видеофайлы товара.
Информация о медиафайле товара.

Min items: 1

OfferParamDTO

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

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

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

Name

Description

name*

Type: string

Название характеристики.

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

Example: Wi-Fi

Max length: 200

value*

Type: string

Значение.

Example: есть

OfferSellingProgramDTO

Информация о том, по каким моделям можно продавать товар, а по каким нельзя.

Name

Description

sellingProgram*

Type: SellingProgramType

Модель размещения.

Enum: FBY, FBS, DBS, EXPRESS

status*

Type: OfferSellingProgramStatusType

Информация о том, можно ли по этой модели продавать товар.

Enum: FINE, REJECT

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

Min value: 0

length*

Type: number

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

Example: 65.55

Min value: 0

weight*

Type: number

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

Example: 1.001

Min value: 0

width*

Type: number

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

Example: 50.7

Min value: 0

ShowcaseType

Тип витрины:

Type

Description

ShowcaseType

Enum: B2B, B2C

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

OfferCampaignStatusType

Статус товара:

  • PUBLISHED — Готов к продаже.
  • CHECKING — На проверке.
  • DISABLED_BY_PARTNER — Скрыт вами.
  • REJECTED_BY_MARKET — Отклонен.
  • DISABLED_AUTOMATICALLY — Исправьте ошибки.
  • CREATING_CARD — Создается карточка.
  • NO_CARD — Нужна карточка.
  • NO_STOCKS — Нет на складе.
  • ARCHIVED — В архиве.

Что обозначает каждый из статусов

Type

Description

OfferCampaignStatusType

Enum: PUBLISHED, CHECKING, DISABLED_BY_PARTNER, DISABLED_AUTOMATICALLY, REJECTED_BY_MARKET, CREATING_CARD, NO_CARD, NO_STOCKS, ARCHIVED

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

OfferMediaFileDTO

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

Name

Description

title

Type: string

Название медиафайла.

uploadState

Type: MediaFileUploadStateType

Состояние загрузки медиафайла.

Enum: UPLOADING, UPLOADED, FAILED

url

Type: string

Ссылка на медиафайл.

Min length: 1

Max length: 2000

SellingProgramType

Модель размещения:

  • FBY — FBY.
  • FBS — FBS.
  • DBS — DBS.
  • EXPRESS — Экспресс.

Type

Description

SellingProgramType

Enum: FBY, FBS, DBS, EXPRESS

OfferSellingProgramStatusType

Информация о доступности или недоступности.

  • FINE — доступно.
  • REJECT — недоступно.

Type

Description

OfferSellingProgramStatusType

Enum: FINE, REJECT

MediaFileUploadStateType

Состояние загрузки медиафайла:

  • UPLOADING — загружается.
  • UPLOADED — успешно загружен.
  • FAILED — при загрузке произошла ошибка. Повторите попытку позже.

Type

Description

MediaFileUploadStateType

Enum: UPLOADING, UPLOADED, FAILED

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

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

No longer supported, please use an alternative and newer version.

Что такое GTIN
GTIN — это уникальный номер, присвоенный товару в единой международной базе GS1. Из этого номера получается штрихкод формата EAN, UPC или ISBN.

Как убедиться, что товар есть в базе
Проверить код можно на странице проверки на сайте ассоциации GS1. Если товар не находится, запросите код GTIN у вашего поставщика.

Как получить GTIN для своих товаров
Чтобы получить коды GTIN, производителю нужно вступить в ассоциацию GS1 и зарегистрировать товары.

Предыдущая
Редактирование категорийных характеристик товара
Следующая
В магазине