Request
Responses
200 OK
400 Bad Request
- Body
- ApiErrorDTO
401 Unauthorized
- Body
403 Forbidden
- Body
404 Not Found
- Body
420 Method Failure
- Body
500 Internal Server Error
- Body

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

Info

Console

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

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

задать список интересующих 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.

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

Query parameters

Name

Description

limit

Type: integer<int32>

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

page_token

Type: string

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

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

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

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

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`
categoryIds	Type: integer[] Фильтр по категориям на Маркете.
offerIds	Type: string[] Идентификаторы товаров, информация о которых нужна. Такой список возвращается только целиком Если вы запрашиваете информацию по конкретным SKU, не заполняйте: `page_token`; `limit`; `cardStatuses`; `categoryIds`; `vendorNames`; `tags`; `archived`. Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 255 знаков. Правила использования SKU: У каждого товара SKU должен быть свой. SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. Что такое SKU и как его назначать Min length: `1` Max length: `255` Pattern: `^[^\x00-\x08\x0A-\x1f\x7f]{1,255}$` Max items: `200`
tags	Type: string[] Фильтр по тегам.
vendorNames	Type: string[] Фильтр по брендам.

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`

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,
                    "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

Description

result

Type: GetOfferMappingsResultDTO

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

GetOfferMappingsResultDTO

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

Name

Description

offerMappings

Type: GetOfferMappingDTO[]

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

paging

Type: ScrollingPagerDTO

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

ApiResponseStatusType

Тип ответа.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

GetOfferMappingDTO

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

Name

Description

mapping

Type: GetMappingDTO

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

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

offer

Type: GetOfferDTO

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

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> Идентификатор карточки на Маркете.
marketSkuName	Type: string Название карточки товара. Может отсутствовать в ответе, если товар еще не привязан к карточке.

GetOfferDTO

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

Name	Description
offerId*	Type: string Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 255 знаков. Правила использования SKU: У каждого товара SKU должен быть свой. SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. Что такое SKU и как его назначать Min length: `1` Max length: `255` Pattern: `^[^\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`
basicPrice	Type: GetPriceWithDiscountDTO Цена. Цена с указанием скидки. Время последнего обновления.
boxCount	Type: integer<int32> Количество грузовых мест. Параметр используется, если товар представляет собой несколько коробок, упаковок и так далее. Например, кондиционер занимает два места — внешний и внутренний блоки в двух коробках. Для товаров, занимающих одно место, не передавайте этот параметр.
campaigns	Type: OfferCampaignStatusDTO[] Список магазинов, в которых размещен товар. Статус товара в магазине.
cardStatus	Type: 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`
category	Type: string Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре `marketCategoryId`. Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда. Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре `marketCategoryId`.
certificates	Type: string[] Номера документов на товар: сертификата, декларации соответствия и т. п. Передавать можно только номера документов, сканы которого загружены в кабинете продавца по инструкции.
cofinancePrice	Type: GetPriceDTO Цена для скидок с Маркетом. Маркет может компенсировать до половины скидки. Назначьте минимальную цену до вычета тарифов, по которой готовы продавать товар, а мы рассчитаем скидку и размер софинансирования. Если Маркет не готов софинансировать скидку, покупатель ее не увидит. Цена на товар. Время последнего обновления.
condition	Type: OfferConditionDTO Состояние уцененного товара. Используется только для товаров, продаваемых с уценкой. Правила продажи уцененных товаров
customsCommodityCode	Type: string Код товара в единой Товарной номенклатуре внешнеэкономической деятельности (ТН ВЭД) — 10 или 14 цифр без пробелов. Обязательно укажите, если он есть. Example: `8517610008`
description	Type: string Подробное описание товара: например, его преимущества и особенности. Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок. Можно использовать теги: <h>, <h1>, <h2> и так далее — для заголовков; <br> и <p> — для переноса строки; <ol> — для нумерованного списка; <ul> — для маркированного списка; <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>); <div> — поддерживается, но не влияет на отображение текста. Оптимальная длина — 400–600 символов, максимальная — 6000. Рекомендации и правила Max length: `6000`
downloadable	Type: boolean Признак цифрового товара. Укажите `true`, если товар доставляется по электронной почте. Как работать с цифровыми товарами
guaranteePeriod	Type: TimePeriodDTO Гарантийный срок — период, в течение которого можно бесплатно заменить или починить товар. Обязательно указывайте срок, если он есть. В комментарии опишите особенности гарантийного обслуживания. Например, `Гарантия на аккумулятор — 6 месяцев`.
lifeTime	Type: TimePeriodDTO Срок службы — период, в течение которого товар должен исправно выполнять свою функцию. Обязательно указывайте срок, если он есть. В комментарии укажите условия хранения. Например, `Использовать при температуре не ниже −10 градусов`.
manuals	Type: OfferManualDTO[] Список инструкций по использованию товара. Максимальное количество инструкций — 6. Если вы передадите пустое поле `manuals`, загруженные ранее инструкции удалятся. Инструкция по использованию товара. Max items: `6`
manufacturerCountries	Type: string[] Страна, где был произведен товар. Записывайте названия стран так, как они записаны в списке. Example: `Россия`
marketCategoryId	Type: integer<int64> Идентификатор категории на Маркете, к которой вы относите свой товар. Если не указать `marketCategoryId`, то маркетная категория будет определена автоматически. При изменении информации о товаре передавайте тот же идентификатор категории. Если вы укажете другой, категория товара не поменяется. Изменить ее можно только в кабинете продавца на Маркете. Список категорий Маркета можно получить с помощью запроса POST categories/tree.
name	Type: string Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке. Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей. Оптимальная длина — 50–60 символов, максимальная — 256. Рекомендации и правила Example: `Ударная дрель Makita HP1630, 710 Вт` Max length: `256`
params	Type: OfferParamDTO[] Этот параметр устарел. При передаче характеристик используйте `parameterValues`. Характеристики, которые есть только у товаров конкретной категории — например, диаметр колес велосипеда или материал подошвы обуви. Параметры товара. Если у товара несколько значений одного параметра, передайте их с одним и тем же `name`, но разными `value`. Пример `"params": [ { "name": "Цвет", "value": "Зеленый" }, { "name": "Цвет", "value": "Желтый" } ]`
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` Ссылки на изображение должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке. Если нужно заменить изображение, выложите новое изображение по новой ссылке, а ссылку на старое удалите. Если просто заменить изображение по старой ссылке, оно не обновится. Требования к изображениям
purchasePrice	Type: GetPriceDTO Себестоимость — затраты на самостоятельное производство товара или закупку у производителя или поставщиков. Цена на товар. Время последнего обновления.
sellingPrograms	Type: OfferSellingProgramDTO[] Информация о том, какие для товара доступны модели размещения. Информация о том, по каким моделям можно продавать товар, а по каким нельзя.
shelfLife	Type: TimePeriodDTO Срок годности — период, по прошествии которого товар становится непригоден. Указывайте срок, указанный на банке или упаковке. Текущая дата, дата поставки или дата отгрузки значения не имеет. Обязательно указывайте срок, если он есть. В комментарии укажите условия хранения. Например, `Хранить в сухом помещении`.
tags	Type: string[] Метки товара, используемые магазином. Покупателям теги не видны. По тегам можно группировать и фильтровать разные товары в каталоге — например, товары одной серии, коллекции или линейки. Максимальная длина тега 20 символов. У одного товара может быть максимум 10 тегов. Всего можно создать не больше 50 разных тегов. Example: `до 500 рублей`
type	Type: OfferType Особый тип товара. Указывается, если товар: лекарство; бумажная или электронная книга; аудиокнига; музыка или видео; изготовляется на заказ. Enum: `DEFAULT`, `MEDICINE`, `BOOK`, `AUDIOBOOK`, `ARTIST_TITLE`, `ON_DEMAND`
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` Ссылки на видео должны быть постоянными. Нельзя использовать динамические ссылки, меняющиеся от выгрузки к выгрузке. Если нужно заменить видео, выложите новое видео по новой ссылке, а ссылку на старое удалите. Если просто заменить видео по старой ссылке, оно не обновится. Требования к видео Max items: `6`
weightDimensions	Type: OfferWeightDimensionsDTO Габариты упаковки и вес товара.

GetPriceDTO

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

Name	Description
currencyId*	Type: CurrencyType Валюта. Если `BasePriceDTO` присутствует в запросе, указывайте `RUR` — российский рубль. 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 Значение.

AgeDTO

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

Name

Description

ageUnit*

Type: AgeUnitType

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

Enum: YEAR, MONTH

value*

Type: number

Значение.

GetPriceWithDiscountDTO

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

Name	Description
updatedAt*	Type: string<date-time> Время последнего обновления.
currencyId	Type: CurrencyType Валюта. Если `BasePriceDTO` присутствует в запросе, указывайте `RUR` — российский рубль. 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%. Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар.
value	Type: number Значение.

OfferCampaignStatusDTO

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

Name

Description

campaignId*

Type: integer<int64>

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

status*

Type: OfferCampaignStatusType

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

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

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 Комментарий.

OfferManualDTO

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

Name

Description

url*

Type: string

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

title

Type: string

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

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: есть

OfferSellingProgramDTO

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

Name

Description

sellingProgram*

Type: SellingProgramType

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

Enum: FBY, FBS, DBS, EXPRESS

status*

Type: OfferSellingProgramStatusType

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

Enum: FINE, REJECT

OfferType

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

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

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

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

Type	Description
OfferType	Enum: `DEFAULT`, `MEDICINE`, `BOOK`, `AUDIOBOOK`, `ARTIST_TITLE`, `ON_DEMAND`

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

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

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

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`

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`

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`

400 Bad Request

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

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

RequestRequest

Path parametersPath parameters

Query parametersQuery parameters

BodyBody

OfferCardStatusTypeOfferCardStatusType

ResponsesResponses

200 OK200 OK

BodyBody

GetOfferMappingsResultDTOGetOfferMappingsResultDTO

ApiResponseStatusTypeApiResponseStatusType

GetOfferMappingDTOGetOfferMappingDTO

ScrollingPagerDTOScrollingPagerDTO

GetMappingDTOGetMappingDTO

GetOfferDTOGetOfferDTO

GetPriceDTOGetPriceDTO

AgeDTOAgeDTO

GetPriceWithDiscountDTOGetPriceWithDiscountDTO

OfferCampaignStatusDTOOfferCampaignStatusDTO

OfferConditionDTOOfferConditionDTO

TimePeriodDTOTimePeriodDTO

OfferManualDTOOfferManualDTO

OfferParamDTOOfferParamDTO

OfferSellingProgramDTOOfferSellingProgramDTO

OfferTypeOfferType

OfferWeightDimensionsDTOOfferWeightDimensionsDTO

CurrencyTypeCurrencyType

AgeUnitTypeAgeUnitType

OfferCampaignStatusTypeOfferCampaignStatusType

OfferConditionQualityTypeOfferConditionQualityType

OfferConditionTypeOfferConditionType

TimeUnitTypeTimeUnitType

SellingProgramTypeSellingProgramType

OfferSellingProgramStatusTypeOfferSellingProgramStatusType

400 Bad Request400 Bad Request

BodyBody

ApiErrorDTOApiErrorDTO

401 Unauthorized401 Unauthorized

BodyBody

403 Forbidden403 Forbidden

BodyBody

404 Not Found404 Not Found

BodyBody

420 Method Failure420 Method Failure

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

Была ли статья полезна?

Request

Path parameters

Query parameters

Body

OfferCardStatusType

Responses

200 OK

Body

GetOfferMappingsResultDTO

ApiResponseStatusType

GetOfferMappingDTO

ScrollingPagerDTO

GetMappingDTO

GetOfferDTO

GetPriceDTO

AgeDTO

GetPriceWithDiscountDTO

OfferCampaignStatusDTO

OfferConditionDTO

TimePeriodDTO

OfferManualDTO

OfferParamDTO

OfferSellingProgramDTO

OfferType

OfferWeightDimensionsDTO

CurrencyType

AgeUnitType

OfferCampaignStatusType

OfferConditionQualityType

OfferConditionType

TimeUnitType

SellingProgramType

OfferSellingProgramStatusType

400 Bad Request

Body

ApiErrorDTO

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

420 Method Failure

Body

500 Internal Server Error

Body