Информация о товарах, которые размещены в заданном магазине
Метод доступен для моделей: FBY, FBS, Экспресс и DBS.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- offers-and-cards-management — Управление товарами и карточками
- offers-and-cards-management:read-only — Просмотр товаров и карточек
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.
| ⚙️ Лимит: 10 000 товаров в минуту |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/offers
Path parameters
|
Name |
Description |
|
campaignId |
Type: integer Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
⚠️ Не путайте его с:
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer Количество значений на одной странице. Min value: |
|
page_token |
Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуем передавать значение выходного параметра Если задан Example: |
Body
application/json
{
"offerIds": [
"example"
],
"statuses": [
"PUBLISHED"
],
"categoryIds": [
0
],
"vendorNames": [
"example"
],
"tags": [
"example"
]
}
|
Name |
Description |
|
categoryIds |
Type: integer[] | null Фильтр по категориям на Маркете. Min items: Unique items: Example
|
|
offerIds |
Type: ShopSku[] | null Идентификаторы товаров, информация о которых нужна. Такой список возвращается только целиком Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым. Если вы запрашиваете информацию по конкретным SKU, не заполняйте:
Min items: Max items: Unique items: Example
|
|
statuses |
Type: OfferCampaignStatusType[] | null Фильтр по статусам товаров. Min items: Unique items: Example
|
|
tags |
Type: string[] | null Фильтр по тегам. Min items: Unique items: Example
|
|
vendorNames |
Type: string[] | null Фильтр по брендам. Min items: Unique items: 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
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
Responses
200 OK
Список товаров, размещенных в заданном магазине.
Body
application/json
{
"status": "OK"
}
Type: object
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
Type: string
Enum: OK, ERROR
ApiResponse
Стандартная обертка для ответов сервера.
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
Example
{
"status": "OK"
}
ForwardScrollingPagerDTO
Идентификатор следующей страницы.
|
Name |
Description |
|
nextPageToken |
Type: string Идентификатор следующей страницы результатов. Example: |
Example
{
"nextPageToken": "example"
}
ScrollingPagerDTO
Информация о страницах результатов.
Type: object
All of 2 types
-
Type: ForwardScrollingPagerDTO
Идентификатор следующей страницы.
Example
{ "nextPageToken": "example" } -
Type: object
prevPageToken
Type: string
Идентификатор предыдущей страницы результатов.
Example:
exampleExample
{ "prevPageToken": "example" }
Example
{
"nextPageToken": "example"
}
QuantumDTO
Deprecated
Настройка продажи квантами.
Чтобы сбросить установленные ранее значения, передайте пустой параметр quantum.
Пример
{
"offers": [
{
"offerId": "08e35dc1-89a2-11e3-8055-0015e9b8c48d",
"quantum": {}
}
]
}
|
Name |
Description |
|
minQuantity |
Type: integer Минимальное количество единиц товара в заказе. Например, если указать 10, покупатель сможет добавить в корзину не меньше 10 единиц. ⚠️ Если количество товара на складе меньше заданного, ограничение не сработает и покупатель сможет его заказать. Min value: |
|
stepQuantity |
Type: integer На сколько единиц покупатель сможет увеличить количество товара в корзине. Например, если задать 5, покупатель сможет добавить к заказу только 5, 10, 15, ... единиц товара. ⚠️ Если количество товара на складе не дотягивает до кванта, ограничение не сработает и покупатель сможет заказать количество, не кратное кванту. Min value: Max value: |
Example
{
"minQuantity": 1,
"stepQuantity": 1
}
BaseCampaignOfferDTO
Информация о новой цене на товар.
|
Name |
Description |
|
offerId |
Type: ShopSku Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Важно Пробельные символы в начале и конце значения автоматически удаляются. Например, Что такое SKU и как его назначать Min length: Max length: Pattern: Example: |
|
available |
Type: boolean Вместо него используйте методы скрытия товаров с витрины
Есть ли товар в продаже. |
|
quantum |
Type: QuantumDTO Настройка продажи квантами. Что это значит? Настройка продажи квантами. Чтобы сбросить установленные ранее значения, передайте пустой параметр Пример
Example
|
Example
{
"offerId": "example",
"quantum": {
"minQuantity": 1,
"stepQuantity": 1
},
"available": true
}
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 Валюта. Коды валют:
Enum: |
|
value |
Type: number Цена товара. Min value: Exclusive min: |
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:
0Exclusive min:
trueExample:
0Example
{ "discountBase": 0 }
Example
{
"value": 0,
"currencyId": "RUR"
}
UpdateTimeDTO
Время последнего обновления.
|
Name |
Description |
|
updatedAt |
Type: string<date-time> Время последнего обновления. Example: |
Example
{
"updatedAt": "2025-01-01T00:00:00Z"
}
GetPriceWithDiscountDTO
Цена с указанием валюты, скидки и времени последнего обновления.
Type: object
All of 2 types
-
Type: PriceWithDiscountDTO
Цена с указанием скидки.
Example
{ "value": 0, "currencyId": "RUR" } -
Type: UpdateTimeDTO
Время последнего обновления.
Example
{ "updatedAt": "2025-01-01T00:00:00Z" }
Example
{
"value": 0,
"currencyId": "RUR"
}
VatType
Идентификатор НДС, применяемый для товара:
2— НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров.5— НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров.6— НДС не облагается, используется только для отдельных видов услуг.7— НДС 20%. Основной НДС с 2019 года до 1 января 2026 года.10— НДС 5%. НДС для упрощенной системы налогообложения (УСН).11— НДС 7%. НДС для упрощенной системы налогообложения (УСН).14— НДС 22%. Основной НДС с 1 января 2026 года.
Если параметр не указан, используется НДС, установленный в кабинете.
Для продавцов Market Yandex Go недоступна передача и получение НДС.
Type: integer
PriceDTO
Цена с указанием скидки, валюты и времени последнего обновления.
|
Name |
Description |
|
currencyId |
Type: CurrencyType Валюта, в которой указана цена товара. Коды валют:
Enum: |
|
discountBase |
Type: DiscountBase Зачеркнутая цена. Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%. Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар. Min value: Exclusive min: Example: |
|
value |
Type: number Цена товара. Min value: Exclusive min: |
|
vat |
Type: VatType Идентификатор НДС, применяемый для товара:
Если параметр не указан, используется НДС, установленный в кабинете. Для продавцов Market Yandex Go недоступна передача и получение НДС. Example: |
Example
{
"value": 0,
"discountBase": 0,
"currencyId": "RUR",
"vat": 0
}
GetPriceWithVatDTO
Цена с указанием НДС и времени последнего обновления.
Type: object
All of 2 types
-
Type: PriceDTO
Цена с указанием скидки, валюты и времени последнего обновления.
Example
{ "value": 0, "discountBase": 0, "currencyId": "RUR", "vat": 0 } -
Type: UpdateTimeDTO
Время последнего обновления.
Example
{ "updatedAt": "2025-01-01T00:00:00Z" }
Example
{
"value": 0,
"discountBase": 0,
"currencyId": "RUR",
"vat": 0
}
OfferErrorDTO
Сообщение об ошибке, связанной с размещением товара.
|
Name |
Description |
|
comment |
Type: string Пояснение. Example: |
|
message |
Type: string Тип ошибки. Example: |
Example
{
"message": "example",
"comment": "example"
}
GetCampaignOfferDTO
Параметры размещения товара в магазине.
Type: object
All of 2 types
-
Type: BaseCampaignOfferDTO
Информация о новой цене на товар.
Example
{ "offerId": "example", "quantum": { "minQuantity": 1, "stepQuantity": 1 }, "available": true } -
Type: object
basicPrice
Type: GetPriceWithDiscountDTO
Цена товара для всех магазинов.
Цена с указанием валюты, скидки и времени последнего обновления.
Example
{ "value": 0, "currencyId": "RUR" }campaignPrice
Type: GetPriceWithVatDTO
Цена, установленная в отдельном магазине.
Цена с указанием НДС и времени последнего обновления.
Example
{ "value": 0, "discountBase": 0, "currencyId": "RUR", "vat": 0 }errors
Type: OfferErrorDTO[] | null
Ошибки, препятствующие размещению товара на витрине.
Min items:
1Example
[ { "message": "example", "comment": "example" } ]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,ARCHIVEDwarnings
Type: OfferErrorDTO[] | null
Предупреждения, не препятствующие размещению товара на витрине.
Min items:
1Example
[ { "message": "example", "comment": "example" } ]Example
{ "basicPrice": { "value": 0, "currencyId": "RUR" }, "campaignPrice": { "value": 0, "discountBase": 0, "currencyId": null, "vat": 0 }, "status": "PUBLISHED", "errors": [ { "message": "example", "comment": "example" } ], "warnings": [ null ] }
Example
{
"offerId": "example",
"quantum": {
"minQuantity": 1,
"stepQuantity": 1
},
"available": true
}
GetCampaignOffersResultDTO
Список товаров в заданном магазине.
|
Name |
Description |
|
offers |
Type: GetCampaignOfferDTO[] Страница списка товаров. Example
|
|
paging |
Type: ScrollingPagerDTO Информация о страницах результатов. Example
|
Example
{
"paging": {
"nextPageToken": "example"
},
"offers": [
{
"offerId": "example",
"quantum": {
"minQuantity": 1,
"stepQuantity": 1
},
"available": true
}
]
}
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code |
Type: string Код ошибки. Example: |
|
message |
Type: string Описание ошибки. 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:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
Example
{
"status": "OK"
}
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
pathParams:
- description: "Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.\n\nЕго можно узнать с помощью запроса [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → **Настройки** и в меню слева выберите **API и модули**:\n\n* блок **Идентификатор кампании**;\n* вкладка **Лог запросов** → выпадающий список в блоке **Показывать логи**.\n\n⚠️ Не путайте его с:\n- идентификатором магазина, который отображается в личном кабинете продавца;\n- рекламными кампаниями.\n"
name: campaignId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
searchParams:
- name: page_token
description: >
Идентификатор страницы c результатами.
Если параметр не указан, возвращается первая страница.
Рекомендуем передавать значение выходного параметра `nextPageToken`,
полученное при последнем запросе.
Если задан `page_token` и в запросе есть параметры `page` и `pageSize`,
они игнорируются.
in: query
required: false
example: eyBuZXh0SWQ6IDIzNDIgfQ==
schema:
type: string
- name: limit
description: |
Количество значений на одной странице.
in: query
required: false
example: 20
schema:
type: integer
format: int32
minimum: 1
headers: []
body: |-
{
"offerIds": [
"example"
],
"statuses": [
"PUBLISHED"
],
"categoryIds": [
0
],
"vendorNames": [
"example"
],
"tags": [
"example"
]
}
schema:
description: >
Фильтрации товаров
В запросе можно указать либо фильтр offerIds, либо любые другие фильтры
товаров. Совместное использование фильтра `offerIds` с другими фильтрациями
приведет к ошибке.
type: object
properties:
offerIds:
description: "Идентификаторы товаров, информация о которых нужна.\n\n{% note warning \"Такой список возвращается только целиком\" %}\n\nНе используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.\n\nЕсли вы запрашиваете информацию по конкретным SKU, не заполняйте:\n\n* `page_token`\n* `limit`\n\n{% endnote %}\n\n\_\n"
type: array
nullable: true
items:
description: "Ваш SKU —\_идентификатор товара в вашей системе.\n\nПравила использования SKU:\n\n* У каждого товара SKU должен быть свой.\n\n* Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.\n\nSKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/assortment/operations/edit-sku).\n\n{% note warning %}\n\nПробельные символы в начале и конце значения автоматически удаляются. Например, `\" SKU123 \"` и `\"SKU123\"` будут обработаны как одинаковые значения.\n\n{% endnote %}\n\n[Что такое SKU и как его назначать](https://yandex.ru/support/marketplace/assortment/add/index.html#fields)\n"
type: string
pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
x-transform: trim
minLength: 1
maxLength: 255
minItems: 1
maxItems: 200
uniqueItems: true
statuses:
description: |
Фильтр по статусам товаров.
type: array
nullable: true
items:
description: >
Статус товара:
* `PUBLISHED` — Готов к продаже.
* `CHECKING` — На проверке.
* `DISABLED_BY_PARTNER` — Скрыт вами.
* `REJECTED_BY_MARKET` — Отклонен.
* `DISABLED_AUTOMATICALLY` — Исправьте ошибки.
* `CREATING_CARD` — Создается карточка.
* `NO_CARD` — Нужна карточка.
* `NO_STOCKS` — Нет на складе.
* `ARCHIVED` — В архиве.
[Что обозначает каждый из
статусов](https://yandex.ru/support/marketplace/assortment/add/statuses.html)
type: string
enum:
- PUBLISHED
- CHECKING
- DISABLED_BY_PARTNER
- DISABLED_AUTOMATICALLY
- REJECTED_BY_MARKET
- CREATING_CARD
- NO_CARD
- NO_STOCKS
- ARCHIVED
minItems: 1
uniqueItems: true
categoryIds:
description: Фильтр по категориям на Маркете.
type: array
nullable: true
items:
type: integer
format: int32
minimum: 0
exclusiveMinimum: true
minItems: 1
uniqueItems: true
vendorNames:
description: Фильтр по брендам.
type: array
nullable: true
items:
type: string
minItems: 1
uniqueItems: true
tags:
description: Фильтр по тегам.
type: array
nullable: true
items:
type: string
minItems: 1
uniqueItems: true
bodyType: application/json
method: post
security:
- type: apiKey
name: Api-Key
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/campaigns/{campaignId}/offers
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.