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

Метод доступен для моделей: FBY, FBS, Экспресс и DBS.

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

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

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

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

Чтобы получить категорийные характеристики товаров, воспользуйтесь методом POST v2/businesses/{businessId}/offer-cards.

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

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Query parameters

Name

Description

language

Type: CatalogLanguageType

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

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

Язык:

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

Enum: RU, UZ

limit

Type: integer

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

Min value: 1

page_token

Type: string

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

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

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

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

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

CatalogLanguageType

Язык:

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

Type: string

Enum: RU, UZ

Body

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

Name

Description

archived

Type: boolean

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

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

cardStatuses

Type: OfferCardStatusType[] | null

Фильтр по статусам карточек.

Что такое карточка товара

Min items: 1

Unique items: true

Example
[
  "HAS_CARD_CAN_NOT_UPDATE"
]

categoryIds

Type: integer[] | null

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

Min items: 1

Unique items: true

Example
[
  0
]

offerIds

Type: ShopSku[] | null

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

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

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

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

Min items: 1

Max items: 200

Unique items: true

Example
[
  "example"
]

tags

Type: string[] | null

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

Min items: 1

Unique items: true

Example
[
  "example"
]

vendorNames

Type: string[] | null

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

Min items: 1

Unique items: true

Example
[
  "example"
]

ShopSku

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

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

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

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

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

Важно

Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.

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

Type: string

Min length: 1

Max length: 255

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

Example: example

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

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": "example",
      "prevPageToken": "example"
    },
    "offerMappings": [
      {
        "offer": {},
        "mapping": {},
        "showcaseUrls": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: GetOfferMappingsResultDTO

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

    Example
    {
  "paging": {
    "nextPageToken": "example",
    "prevPageToken": "example"
  },
  "offerMappings": [
    {
      "offer": {
        "offerId": "example",
        "name": "Ударная дрель Makita HP1630, 710 Вт",
        "marketCategoryId": 0,
        "category": "example",
        "pictures": [
          null
        ],
        "videos": [
          null
        ],
        "manuals": [
          null
        ],
        "vendor": "LEVENHUK",
        "barcodes": [
          null
        ],
        "description": "example",
        "manufacturerCountries": [
          null
        ],
        "weightDimensions": {},
        "vendorCode": "VNDR-0005A",
        "tags": [
          null
        ],
        "shelfLife": {},
        "lifeTime": null,
        "guaranteePeriod": null,
        "customsCommodityCode": "8517610008",
        "commodityCodes": [
          null
        ],
        "certificates": [
          null
        ],
        "boxCount": 1,
        "condition": {},
        "type": "DEFAULT",
        "downloadable": true,
        "adult": true,
        "age": {},
        "params": [
          null
        ],
        "basicPrice": {},
        "purchasePrice": {},
        "additionalExpenses": null,
        "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
        "campaigns": [
          null
        ],
        "sellingPrograms": [
          null
        ],
        "mediaFiles": {},
        "archived": true,
        "groupId": "example"
      },
      "mapping": {
        "marketSku": 1,
        "marketSkuName": "example",
        "marketModelId": 0,
        "marketModelName": "example",
        "marketCategoryId": 0,
        "marketCategoryName": "example"
      },
      "showcaseUrls": [
        {
          "showcaseType": "B2B",
          "showcaseUrl": "example"
        }
      ]
    }
  ]
}
    Example
    {
  "result": {
    "paging": {
      "nextPageToken": "example",
      "prevPageToken": "example"
    },
    "offerMappings": [
      {
        "offer": {},
        "mapping": {},
        "showcaseUrls": [
          {}
        ]
      }
    ]
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

Example: example
Example
{
  "nextPageToken": "example"
}

ScrollingPagerDTO

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

Type: object

All of 2 types

  • Type: ForwardScrollingPagerDTO

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

    Example
    {
  "nextPageToken": "example"
}
  • Type: object

    prevPageToken

    Type: string

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

    Example: example
    Example
    {
  "prevPageToken": "example"
}
Example
{
  "nextPageToken": "example",
  "prevPageToken": "example"
}

PartnerMarketCategoryId

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

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

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

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

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

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

Type: integer

Min value: 0

Exclusive min: true

OfferCategory

Deprecated

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

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

Type: string

Example: example

Url

Type: string

Min length: 1

Max length: 2000

Example: example

OfferManualDTO

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

Name

Description

url

Type: Url

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

Min length: 1

Max length: 2000

Example: example

title

Type: string

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

Max length: 500

Example: example
Example
{
  "url": "example",
  "title": "example"
}

OfferVendor

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

Type: string

Example: LEVENHUK

OfferBarcodes

Штрихкод.

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

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

Что такое GTIN

Type: string[] | null

Min items: 1

Unique items: true

Example
[
  "46012300000000"
]

BaseOfferManufacturerCountries

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

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

Type: string[] | null

Min items: 1

Unique items: true

Example
[
  "Россия"
]

OfferWeightDimensionsDTO

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

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

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

Name

Description

height

Type: number

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

Min value: 0

length

Type: number

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

Min value: 0

weight

Type: number

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

Min value: 0

width

Type: number

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

Min value: 0
Example
{
  "length": 65.55,
  "width": 50.7,
  "height": 20,
  "weight": 1.001
}

OfferVendorCode

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

Type: string

Example: VNDR-0005A

BaseOfferTags

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

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

Type: string[] | null

Min items: 1

Max items: 50

Unique items: true

Example
[
  "до 500 рублей"
]

TimeUnitType

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

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

Type: string

Enum: HOUR, DAY, WEEK, MONTH, YEAR

TimePeriodDTO

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

Name

Description

timePeriod

Type: integer

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

timeUnit

Type: TimeUnitType

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

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

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

Enum: HOUR, DAY, WEEK, MONTH, YEAR

comment

Type: string

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

Max length: 500

Example: example
Example
{
  "timePeriod": 0,
  "timeUnit": "HOUR",
  "comment": "example"
}

BaseOfferCustomsCommodityCode

Deprecated

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

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

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

Type: string

Example: 8517610008

CommodityCodeType

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

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

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

Type: string

Enum: CUSTOMS_COMMODITY_CODE, IKPU_CODE

CommodityCodeDTO

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

Name

Description

code

Type: string

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

Example: example

type

Type: CommodityCodeType

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

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

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

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

Enum: CUSTOMS_COMMODITY_CODE, IKPU_CODE
Example
{
  "code": "example",
  "type": "CUSTOMS_COMMODITY_CODE"
}

BaseOfferCommodityCodes

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

Type: CommodityCodeDTO[] | null

Min items: 1

Example
[
  {
    "code": "example",
    "type": "CUSTOMS_COMMODITY_CODE"
  }
]

BaseOfferBoxCount

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

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

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

Type: integer

Min value: 1

OfferConditionType

Тип уценки:

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

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

Type: string

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

OfferConditionQualityType

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

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

Type: string

Enum: PERFECT, EXCELLENT, GOOD, NOT_SPECIFIED

OfferConditionDTO

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

Name

Description

quality

Type: OfferConditionQualityType

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

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

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

Enum: PERFECT, EXCELLENT, GOOD, NOT_SPECIFIED

reason

Type: string

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

Example: example

type

Type: OfferConditionType

Тип уценки.

Тип уценки:

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

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

Enum: PREOWNED, SHOWCASESAMPLE, REFURBISHED, REDUCTION, RENOVATED, NOT_SPECIFIED
Example
{
  "type": "PREOWNED",
  "quality": "PERFECT",
  "reason": "example"
}

OfferType

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

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

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

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

Type: string

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

BaseOfferDownloadable

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

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

Type: boolean

BaseOfferAdult

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

Type: boolean

AgeUnitType

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

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

Type: string

Enum: YEAR, MONTH

AgeDTO

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

Name

Description

ageUnit

Type: AgeUnitType

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

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

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

Enum: YEAR, MONTH

value

Type: number

Значение.

Min value: 0
Example
{
  "value": 0,
  "ageUnit": "YEAR"
}

OfferParamDTO

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

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

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

Name

Description

name

Type: string

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

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

Max length: 200

Example: Wi-Fi

value

Type: string

Значение.

Example: есть
Example
{
  "name": "Wi-Fi",
  "value": "есть"
}

BaseOfferParams

Deprecated

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

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

Type: OfferParamDTO[] | null

Min items: 1

Example
[
  {
    "name": "Wi-Fi",
    "value": "есть"
  }
]

BaseOfferResponseDTO

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

Name

Description

offerId

Type: ShopSku

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

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

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

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

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

Важно

Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.

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

Min length: 1

Max length: 255

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

Example: example

adult

Type: BaseOfferAdult

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

Example: true

age

Type: AgeDTO

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

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

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

Example
{
  "value": 0,
  "ageUnit": "YEAR"
}

barcodes

Type: OfferBarcodes

Штрихкод.

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

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

Что такое GTIN

Min items: 1

Unique items: true

Example
[
  "46012300000000"
]

boxCount

Type: BaseOfferBoxCount

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

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

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

Min value: 1

Example: 1

category

Type: OfferCategory

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

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

Example: example

certificates

Type: string[] | null

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

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

Min items: 1

Unique items: true

Example
[
  "example"
]

commodityCodes

Type: BaseOfferCommodityCodes

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

Min items: 1

Example
[
  {
    "code": "example",
    "type": "CUSTOMS_COMMODITY_CODE"
  }
]

condition

Type: OfferConditionDTO

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

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

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

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

Example
{
  "type": "PREOWNED",
  "quality": "PERFECT",
  "reason": "example"
}

customsCommodityCode

Type: BaseOfferCustomsCommodityCode

Вместо него используйте 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 символов.

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

Example: example

downloadable

Type: BaseOfferDownloadable

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

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

Example: true

guaranteePeriod

Type: TimePeriodDTO

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

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

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

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

Example
{
  "timePeriod": 0,
  "timeUnit": "HOUR",
  "comment": "example"
}

lifeTime

Type: TimePeriodDTO

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

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

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

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

Example
{
  "timePeriod": 0,
  "timeUnit": "HOUR",
  "comment": "example"
}

manuals

Type: OfferManualDTO[] | null

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

Min items: 1

Example
[
  {
    "url": "example",
    "title": "example"
  }
]

manufacturerCountries

Type: BaseOfferManufacturerCountries

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

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

Min items: 1

Unique items: true

Example
[
  "Россия"
]

marketCategoryId

Type: PartnerMarketCategoryId

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

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

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

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

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

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

Min value: 0

Exclusive min: true

Example: 0

name

Type: string

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

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

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

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

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

params

Type: BaseOfferParams

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

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

Min items: 1

Example
[
  {
    "name": "Wi-Fi",
    "value": "есть"
  }
]

pictures

Type: Url[] | null

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

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

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

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

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

❌ /images/sku12345.jpg

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

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

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

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

Min items: 1

Example
[
  "example"
]

shelfLife

Type: TimePeriodDTO

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

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

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

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

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

Example
{
  "timePeriod": 0,
  "timeUnit": "HOUR",
  "comment": "example"
}

tags

Type: BaseOfferTags

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

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

Min items: 1

Max items: 50

Unique items: true

Example
[
  "до 500 рублей"
]

type

Type: OfferType

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

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

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

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

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

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

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

vendor

Type: OfferVendor

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

Example: LEVENHUK

vendorCode

Type: OfferVendorCode

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

Example: VNDR-0005A

videos

Type: Url[] | null

Ссылки (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 items: 1

Example
[
  "example"
]

weightDimensions

Type: OfferWeightDimensionsDTO

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

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

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

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

Example
{
  "length": 65.55,
  "width": 50.7,
  "height": 20,
  "weight": 1.001
}
Example
{
  "offerId": "example",
  "name": "Ударная дрель Makita HP1630, 710 Вт",
  "marketCategoryId": 0,
  "category": "example",
  "pictures": [
    "example"
  ],
  "videos": [
    null
  ],
  "manuals": [
    {
      "url": null,
      "title": "example"
    }
  ],
  "vendor": "LEVENHUK",
  "barcodes": [
    "46012300000000"
  ],
  "description": "example",
  "manufacturerCountries": [
    "Россия"
  ],
  "weightDimensions": {
    "length": 65.55,
    "width": 50.7,
    "height": 20,
    "weight": 1.001
  },
  "vendorCode": "VNDR-0005A",
  "tags": [
    "до 500 рублей"
  ],
  "shelfLife": {
    "timePeriod": 0,
    "timeUnit": "HOUR",
    "comment": "example"
  },
  "lifeTime": null,
  "guaranteePeriod": null,
  "customsCommodityCode": "8517610008",
  "commodityCodes": [
    {
      "code": "example",
      "type": "CUSTOMS_COMMODITY_CODE"
    }
  ],
  "certificates": [
    "example"
  ],
  "boxCount": 1,
  "condition": {
    "type": "PREOWNED",
    "quality": "PERFECT",
    "reason": "example"
  },
  "type": "DEFAULT",
  "downloadable": true,
  "adult": true,
  "age": {
    "value": 0,
    "ageUnit": "YEAR"
  },
  "params": [
    {
      "name": "Wi-Fi",
      "value": "есть"
    }
  ]
}

CurrencyType

Коды валют:

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

Type: string

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

BasePriceDTO

Цена товара.

Name

Description

currencyId

Type: CurrencyType

Валюта.

Коды валют:

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

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

value

Type: number

Цена товара.

Min value: 0

Exclusive min: true
Example
{
  "value": 0,
  "currencyId": "RUR"
}

DiscountBase

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

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

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

Type: number

Min value: 0

Exclusive min: true

PriceWithDiscountDTO

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

Type: object

All of 2 types

  • Type: BasePriceDTO

    Цена товара.

    Example
    {
  "value": 0,
  "currencyId": "RUR"
}
  • Type: object

    discountBase

    Type: DiscountBase

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

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

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

    Min value: 0

    Exclusive min: true

    Example: 0
    Example
    {
  "discountBase": 0
}
Example
{
  "value": 0,
  "currencyId": "RUR",
  "discountBase": 0
}

UpdateTimeDTO

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

Name

Description

updatedAt

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z
Example
{
  "updatedAt": "2025-01-01T00:00:00Z"
}

GetPriceWithDiscountDTO

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

Type: object

All of 2 types

  • Type: PriceWithDiscountDTO

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

    Example
    {
  "value": 0,
  "currencyId": "RUR",
  "discountBase": 0
}

  • Type: UpdateTimeDTO

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

    Example
    {
  "updatedAt": "2025-01-01T00:00:00Z"
}
Example
{
  "value": 0,
  "currencyId": "RUR",
  "discountBase": 0,
  "updatedAt": "2025-01-01T00:00:00Z"
}

GetPriceDTO

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

Type: object

All of 2 types

  • Type: BasePriceDTO

    Цена товара.

    Example
    {
  "value": 0,
  "currencyId": "RUR"
}

  • Type: UpdateTimeDTO

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

    Example
    {
  "updatedAt": "2025-01-01T00:00:00Z"
}
Example
{
  "value": 0,
  "currencyId": "RUR",
  "updatedAt": "2025-01-01T00:00:00Z"
}

CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Type: integer

Min value: 1

OfferCampaignStatusType

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

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

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

Type: string

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

OfferCampaignStatusDTO

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

Name

Description

campaignId

Type: CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

Example: 1

status

Type: OfferCampaignStatusType

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

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

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

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

Enum: PUBLISHED, CHECKING, DISABLED_BY_PARTNER, DISABLED_AUTOMATICALLY, REJECTED_BY_MARKET, CREATING_CARD, NO_CARD, NO_STOCKS, ARCHIVED
Example
{
  "campaignId": 1,
  "status": "PUBLISHED"
}

SellingProgramType

Модель работы:

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

Type: string

Enum: FBY, FBS, DBS, EXPRESS, LAAS

OfferSellingProgramStatusType

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

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

Type: string

Enum: FINE, REJECT

OfferSellingProgramDTO

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

Name

Description

sellingProgram

Type: SellingProgramType

Модель работы.

Модель работы:

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

Enum: FBY, FBS, DBS, EXPRESS, LAAS

status

Type: OfferSellingProgramStatusType

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

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

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

Enum: FINE, REJECT
Example
{
  "sellingProgram": "FBY",
  "status": "FINE"
}

MediaFileUploadStateType

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

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

Type: string

Enum: UPLOADING, UPLOADED, FAILED

OfferMediaFileDTO

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

Name

Description

title

Type: string

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

Example: example

uploadState

Type: MediaFileUploadStateType

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

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

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

Enum: UPLOADING, UPLOADED, FAILED

url

Type: Url

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

Min length: 1

Max length: 2000

Example: example
Example
{
  "url": "example",
  "title": "example",
  "uploadState": "UPLOADING"
}

OfferMediaFilesDTO

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

Name

Description

firstVideoAsCover

Type: boolean

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

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

manuals

Type: OfferMediaFileDTO[] | null

Руководства по использованию товара.

Min items: 1

Example
[
  {
    "url": "example",
    "title": "example",
    "uploadState": "UPLOADING"
  }
]

pictures

Type: OfferMediaFileDTO[] | null

Изображения товара.

Min items: 1

Example
[
  {
    "url": "example",
    "title": "example",
    "uploadState": "UPLOADING"
  }
]

videos

Type: OfferMediaFileDTO[] | null

Видеофайлы товара.

Min items: 1

Example
[
  {
    "url": "example",
    "title": "example",
    "uploadState": "UPLOADING"
  }
]
Example
{
  "firstVideoAsCover": true,
  "videos": [
    {
      "url": "example",
      "title": "example",
      "uploadState": "UPLOADING"
    }
  ],
  "pictures": [
    null
  ],
  "manuals": [
    null
  ]
}

GetOfferDTO

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

Type: object

All of 2 types

  • Type: BaseOfferResponseDTO

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

    Example
    {
  "offerId": "example",
  "name": "Ударная дрель Makita HP1630, 710 Вт",
  "marketCategoryId": 0,
  "category": "example",
  "pictures": [
    "example"
  ],
  "videos": [
    null
  ],
  "manuals": [
    {
      "url": null,
      "title": "example"
    }
  ],
  "vendor": "LEVENHUK",
  "barcodes": [
    "46012300000000"
  ],
  "description": "example",
  "manufacturerCountries": [
    "Россия"
  ],
  "weightDimensions": {
    "length": 65.55,
    "width": 50.7,
    "height": 20,
    "weight": 1.001
  },
  "vendorCode": "VNDR-0005A",
  "tags": [
    "до 500 рублей"
  ],
  "shelfLife": {
    "timePeriod": 0,
    "timeUnit": "HOUR",
    "comment": "example"
  },
  "lifeTime": null,
  "guaranteePeriod": null,
  "customsCommodityCode": "8517610008",
  "commodityCodes": [
    {
      "code": "example",
      "type": "CUSTOMS_COMMODITY_CODE"
    }
  ],
  "certificates": [
    "example"
  ],
  "boxCount": 1,
  "condition": {
    "type": "PREOWNED",
    "quality": "PERFECT",
    "reason": "example"
  },
  "type": "DEFAULT",
  "downloadable": true,
  "adult": true,
  "age": {
    "value": 0,
    "ageUnit": "YEAR"
  },
  "params": [
    {
      "name": "Wi-Fi",
      "value": "есть"
    }
  ]
}
  • Type: object

    additionalExpenses

    Type: GetPriceDTO

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

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

    Example
    {
  "value": 0,
  "currencyId": "RUR",
  "updatedAt": "2025-01-01T00:00:00Z"
}

    archived

    Type: boolean

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

    basicPrice

    Type: GetPriceWithDiscountDTO

    Цена.

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

    Example
    {
  "value": 0,
  "currencyId": "RUR",
  "discountBase": 0,
  "updatedAt": "2025-01-01T00:00:00Z"
}

    campaigns

    Type: OfferCampaignStatusDTO[] | null

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

    Min items: 1

    Example
    [
  {
    "campaignId": 1,
    "status": "PUBLISHED"
  }
]

    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

    groupId

    Type: string

    Идентификатор группы товаров.

    У товаров, которые объединены в одну группу, будет одинаковый идентификатор.

    Как объединить товары на карточке

    Example: example

    mediaFiles

    Type: OfferMediaFilesDTO

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

    Example
    {
  "firstVideoAsCover": true,
  "videos": [
    {
      "url": "example",
      "title": "example",
      "uploadState": "UPLOADING"
    }
  ],
  "pictures": [
    null
  ],
  "manuals": [
    null
  ]
}

    purchasePrice

    Type: GetPriceDTO

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

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

    Example
    {
  "value": 0,
  "currencyId": "RUR",
  "updatedAt": "2025-01-01T00:00:00Z"
}

    sellingPrograms

    Type: OfferSellingProgramDTO[] | null

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

    Min items: 1

    Example
    [
  {
    "sellingProgram": "FBY",
    "status": "FINE"
  }
]
    Example
    {
  "basicPrice": {
    "value": 0,
    "currencyId": "RUR",
    "discountBase": 0,
    "updatedAt": "2025-01-01T00:00:00Z"
  },
  "purchasePrice": null,
  "additionalExpenses": null,
  "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
  "campaigns": [
    {
      "campaignId": 1,
      "status": "PUBLISHED"
    }
  ],
  "sellingPrograms": [
    {
      "sellingProgram": "FBY",
      "status": "FINE"
    }
  ],
  "mediaFiles": {
    "firstVideoAsCover": true,
    "videos": [
      {
        "url": "example",
        "title": "example",
        "uploadState": "UPLOADING"
      }
    ],
    "pictures": [
      null
    ],
    "manuals": [
      null
    ]
  },
  "archived": true,
  "groupId": "example"
}
Example
{
  "offerId": "example",
  "name": "Ударная дрель Makita HP1630, 710 Вт",
  "marketCategoryId": 0,
  "category": "example",
  "pictures": [
    "example"
  ],
  "videos": [
    null
  ],
  "manuals": [
    {
      "url": null,
      "title": "example"
    }
  ],
  "vendor": "LEVENHUK",
  "barcodes": [
    "46012300000000"
  ],
  "description": "example",
  "manufacturerCountries": [
    "Россия"
  ],
  "weightDimensions": {
    "length": 65.55,
    "width": 50.7,
    "height": 20,
    "weight": 1.001
  },
  "vendorCode": "VNDR-0005A",
  "tags": [
    "до 500 рублей"
  ],
  "shelfLife": {
    "timePeriod": 0,
    "timeUnit": "HOUR",
    "comment": "example"
  },
  "lifeTime": null,
  "guaranteePeriod": null,
  "customsCommodityCode": "8517610008",
  "commodityCodes": [
    {
      "code": "example",
      "type": "CUSTOMS_COMMODITY_CODE"
    }
  ],
  "certificates": [
    "example"
  ],
  "boxCount": 1,
  "condition": {
    "type": "PREOWNED",
    "quality": "PERFECT",
    "reason": "example"
  },
  "type": "DEFAULT",
  "downloadable": true,
  "adult": true,
  "age": {
    "value": 0,
    "ageUnit": "YEAR"
  },
  "params": [
    {
      "name": "Wi-Fi",
      "value": "есть"
    }
  ],
  "basicPrice": {
    "value": 0,
    "currencyId": "RUR",
    "discountBase": 0,
    "updatedAt": "2025-01-01T00:00:00Z"
  },
  "purchasePrice": null,
  "additionalExpenses": null,
  "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
  "campaigns": [
    {
      "campaignId": 1,
      "status": "PUBLISHED"
    }
  ],
  "sellingPrograms": [
    {
      "sellingProgram": "FBY",
      "status": "FINE"
    }
  ],
  "mediaFiles": {
    "firstVideoAsCover": true,
    "videos": [
      {
        "url": null,
        "title": "example",
        "uploadState": "UPLOADING"
      }
    ],
    "pictures": [
      null
    ],
    "manuals": [
      null
    ]
  },
  "archived": true,
  "groupId": "example"
}

MarketSku

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

Type: integer

Min value: 1

UpdateMappingDTO

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

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

Name

Description

marketSku

Type: MarketSku

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

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

Min value: 1

Example: 1
Example
{
  "marketSku": 1
}

GetMappingDTO

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

Type: object

All of 2 types

  • Type: UpdateMappingDTO

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

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

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

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

    Example
    {
  "marketSku": 1
}
  • Type: object

    marketCategoryId

    Type: integer

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

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

    marketCategoryName

    Type: string

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

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

    Example: example

    marketModelName

    Type: string

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

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

    Example: example

    marketSkuName

    Type: string

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

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

    Example: example
    Example
    {
  "marketSkuName": "example",
  "marketModelName": "example",
  "marketCategoryId": 0,
  "marketCategoryName": "example"
}
Example
{
  "marketSku": 1,
  "marketSkuName": "example",
  "marketModelName": "example",
  "marketCategoryId": 0,
  "marketCategoryName": "example"
}

ShowcaseType

Тип витрины:

Type: string

Enum: B2B, B2C

ShowcaseUrlDTO

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

Name

Description

showcaseType

Type: ShowcaseType

Тип витрины.

Тип витрины:

Enum: B2B, B2C

showcaseUrl

Type: string

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

Example: example
Example
{
  "showcaseType": "B2B",
  "showcaseUrl": "example"
}

GetOfferMappingDTO

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

Name

Description

mapping

Type: GetMappingDTO

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

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

Example
{
  "marketSku": 1,
  "marketSkuName": "example",
  "marketModelId": 0,
  "marketModelName": "example",
  "marketCategoryId": 0,
  "marketCategoryName": "example"
}

offer

Type: GetOfferDTO

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

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

Example
{
  "offerId": "example",
  "name": "Ударная дрель Makita HP1630, 710 Вт",
  "marketCategoryId": 0,
  "category": "example",
  "pictures": [
    "example"
  ],
  "videos": [
    null
  ],
  "manuals": [
    {
      "url": null,
      "title": "example"
    }
  ],
  "vendor": "LEVENHUK",
  "barcodes": [
    "46012300000000"
  ],
  "description": "example",
  "manufacturerCountries": [
    "Россия"
  ],
  "weightDimensions": {
    "length": 65.55,
    "width": 50.7,
    "height": 20,
    "weight": 1.001
  },
  "vendorCode": "VNDR-0005A",
  "tags": [
    "до 500 рублей"
  ],
  "shelfLife": {
    "timePeriod": 0,
    "timeUnit": "HOUR",
    "comment": "example"
  },
  "lifeTime": null,
  "guaranteePeriod": null,
  "customsCommodityCode": "8517610008",
  "commodityCodes": [
    {
      "code": "example",
      "type": "CUSTOMS_COMMODITY_CODE"
    }
  ],
  "certificates": [
    "example"
  ],
  "boxCount": 1,
  "condition": {
    "type": "PREOWNED",
    "quality": "PERFECT",
    "reason": "example"
  },
  "type": "DEFAULT",
  "downloadable": true,
  "adult": true,
  "age": {
    "value": 0,
    "ageUnit": "YEAR"
  },
  "params": [
    {
      "name": "Wi-Fi",
      "value": "есть"
    }
  ],
  "basicPrice": {
    "value": 0,
    "currencyId": "RUR",
    "discountBase": 0,
    "updatedAt": "2025-01-01T00:00:00Z"
  },
  "purchasePrice": null,
  "additionalExpenses": null,
  "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
  "campaigns": [
    {
      "campaignId": 1,
      "status": "PUBLISHED"
    }
  ],
  "sellingPrograms": [
    {
      "sellingProgram": "FBY",
      "status": "FINE"
    }
  ],
  "mediaFiles": {
    "firstVideoAsCover": true,
    "videos": [
      {
        "url": null,
        "title": "example",
        "uploadState": "UPLOADING"
      }
    ],
    "pictures": [
      null
    ],
    "manuals": [
      null
    ]
  },
  "archived": true,
  "groupId": "example"
}

showcaseUrls

Type: ShowcaseUrlDTO[] | null

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

Min items: 1

Example
[
  {
    "showcaseType": "B2B",
    "showcaseUrl": "example"
  }
]
Example
{
  "offer": {
    "offerId": "example",
    "name": "Ударная дрель Makita HP1630, 710 Вт",
    "marketCategoryId": 0,
    "category": "example",
    "pictures": [
      "example"
    ],
    "videos": [
      null
    ],
    "manuals": [
      {
        "url": null,
        "title": "example"
      }
    ],
    "vendor": "LEVENHUK",
    "barcodes": [
      "46012300000000"
    ],
    "description": "example",
    "manufacturerCountries": [
      "Россия"
    ],
    "weightDimensions": {
      "length": 65.55,
      "width": 50.7,
      "height": 20,
      "weight": 1.001
    },
    "vendorCode": "VNDR-0005A",
    "tags": [
      "до 500 рублей"
    ],
    "shelfLife": {
      "timePeriod": 0,
      "timeUnit": "HOUR",
      "comment": "example"
    },
    "lifeTime": null,
    "guaranteePeriod": null,
    "customsCommodityCode": "8517610008",
    "commodityCodes": [
      {
        "code": "example",
        "type": "CUSTOMS_COMMODITY_CODE"
      }
    ],
    "certificates": [
      "example"
    ],
    "boxCount": 1,
    "condition": {
      "type": "PREOWNED",
      "quality": "PERFECT",
      "reason": "example"
    },
    "type": "DEFAULT",
    "downloadable": true,
    "adult": true,
    "age": {
      "value": 0,
      "ageUnit": "YEAR"
    },
    "params": [
      {
        "name": "Wi-Fi",
        "value": "есть"
      }
    ],
    "basicPrice": {
      "updatedAt": "2025-01-01T00:00:00Z"
    },
    "purchasePrice": null,
    "additionalExpenses": null,
    "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
    "campaigns": [
      {
        "campaignId": 1,
        "status": "PUBLISHED"
      }
    ],
    "sellingPrograms": [
      {
        "sellingProgram": "FBY",
        "status": "FINE"
      }
    ],
    "mediaFiles": {
      "firstVideoAsCover": true,
      "videos": [
        {}
      ],
      "pictures": [
        null
      ],
      "manuals": [
        null
      ]
    },
    "archived": true,
    "groupId": "example"
  },
  "mapping": {
    "marketSku": 1,
    "marketSkuName": "example",
    "marketModelId": 0,
    "marketModelName": "example",
    "marketCategoryId": 0,
    "marketCategoryName": "example"
  },
  "showcaseUrls": [
    {
      "showcaseType": "B2B",
      "showcaseUrl": "example"
    }
  ]
}

GetOfferMappingsResultDTO

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

Name

Description

offerMappings

Type: GetOfferMappingDTO[]

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

Example
[
  {
    "offer": {
      "offerId": "example",
      "name": "Ударная дрель Makita HP1630, 710 Вт",
      "marketCategoryId": 0,
      "category": "example",
      "pictures": [
        "example"
      ],
      "videos": [
        null
      ],
      "manuals": [
        {}
      ],
      "vendor": "LEVENHUK",
      "barcodes": [
        "46012300000000"
      ],
      "description": "example",
      "manufacturerCountries": [
        "Россия"
      ],
      "weightDimensions": {
        "length": 65.55,
        "width": 50.7,
        "height": 20,
        "weight": 1.001
      },
      "vendorCode": "VNDR-0005A",
      "tags": [
        "до 500 рублей"
      ],
      "shelfLife": {
        "timePeriod": 0,
        "timeUnit": "HOUR",
        "comment": "example"
      },
      "lifeTime": null,
      "guaranteePeriod": null,
      "customsCommodityCode": "8517610008",
      "commodityCodes": [
        {}
      ],
      "certificates": [
        "example"
      ],
      "boxCount": 1,
      "condition": {
        "type": "PREOWNED",
        "quality": "PERFECT",
        "reason": "example"
      },
      "type": "DEFAULT",
      "downloadable": true,
      "adult": true,
      "age": {
        "value": 0,
        "ageUnit": "YEAR"
      },
      "params": [
        {}
      ],
      "basicPrice": {},
      "purchasePrice": {},
      "additionalExpenses": null,
      "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
      "campaigns": [
        {}
      ],
      "sellingPrograms": [
        {}
      ],
      "mediaFiles": {
        "firstVideoAsCover": true,
        "videos": [
          null
        ],
        "pictures": [
          null
        ],
        "manuals": [
          null
        ]
      },
      "archived": true,
      "groupId": "example"
    },
    "mapping": {
      "marketSku": 1,
      "marketSkuName": "example",
      "marketModelId": 0,
      "marketModelName": "example",
      "marketCategoryId": 0,
      "marketCategoryName": "example"
    },
    "showcaseUrls": [
      {
        "showcaseType": "B2B",
        "showcaseUrl": "example"
      }
    ]
  }
]

paging

Type: ScrollingPagerDTO

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

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

Example
{
  "nextPageToken": "example",
  "prevPageToken": "example"
}
Example
{
  "paging": {
    "nextPageToken": "example",
    "prevPageToken": "example"
  },
  "offerMappings": [
    {
      "offer": {
        "offerId": "example",
        "name": "Ударная дрель Makita HP1630, 710 Вт",
        "marketCategoryId": 0,
        "category": "example",
        "pictures": [
          null
        ],
        "videos": [
          null
        ],
        "manuals": [
          null
        ],
        "vendor": "LEVENHUK",
        "barcodes": [
          null
        ],
        "description": "example",
        "manufacturerCountries": [
          null
        ],
        "weightDimensions": {},
        "vendorCode": "VNDR-0005A",
        "tags": [
          null
        ],
        "shelfLife": {},
        "lifeTime": null,
        "guaranteePeriod": null,
        "customsCommodityCode": "8517610008",
        "commodityCodes": [
          null
        ],
        "certificates": [
          null
        ],
        "boxCount": 1,
        "condition": {},
        "type": "DEFAULT",
        "downloadable": true,
        "adult": true,
        "age": {},
        "params": [
          null
        ],
        "basicPrice": {},
        "purchasePrice": {},
        "additionalExpenses": null,
        "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
        "campaigns": [
          null
        ],
        "sellingPrograms": [
          null
        ],
        "mediaFiles": {},
        "archived": true,
        "groupId": "example"
      },
      "mapping": {
        "marketSku": 1,
        "marketSkuName": "example",
        "marketModelId": 0,
        "marketModelName": "example",
        "marketCategoryId": 0,
        "marketCategoryName": "example"
      },
      "showcaseUrls": [
        {
          "showcaseType": "B2B",
          "showcaseUrl": "example"
        }
      ]
    }
  ]
}

400 Bad Request

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

403 Forbidden

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

404 Not Found

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

420 Method Failure

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

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

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

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

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

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