Информация о товарах, которые размещены в заданном магазине
Возвращает список товаров, которые размещены в заданном магазине. Для каждого товара указываются параметры размещения.
⚙️ Лимит: 5000 товаров в минуту |
---|
Request
POST
https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
Min value: |
Query parameters
Name |
Description |
limit |
Type: integer<int32> Количество значений на одной странице.
|
page_token |
Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра Если задан |
Body
application/json
{
"offerIds": [
"string"
],
"statuses": [
"PUBLISHED"
],
"categoryIds": [
0
],
"vendorNames": [
"string"
],
"tags": [
"string"
]
}
Name |
Description |
categoryIds |
Type: integer[] Фильтр по категориям на Маркете. |
offerIds |
Type: string[] Идентификаторы товаров, информация о которых нужна. Такой список возвращается только целиком Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым. Если вы запрашиваете информацию по конкретным SKU, не заполняйте:
Правила использования SKU:
Что такое SKU и как его назначать Min length: Max length: Pattern: Max items: |
statuses |
Type: OfferCampaignStatusType[] Фильтр по статусам товаров.
Что обозначает каждый из статусов Enum: |
tags |
Type: string[] Фильтр по тегам. |
vendorNames |
Type: string[] Фильтр по брендам. |
OfferCampaignStatusType
Статус товара:
PUBLISHED
— Готов к продаже.CHECKING
— На проверке.DISABLED_BY_PARTNER
— Скрыт вами.REJECTED_BY_MARKET
— Отклонен.DISABLED_AUTOMATICALLY
— Исправьте ошибки.CREATING_CARD
— Создается карточка.NO_CARD
— Нужна карточка.NO_STOCKS
— Нет на складе.ARCHIVED
— В архиве.
Что обозначает каждый из статусов
Type |
Description |
Enum: |
Responses
200 OK
Список товаров, размещенных в заданном магазине.
Body
application/json
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"offers": [
{
"offerId": "string",
"quantum": {
"minQuantity": 0,
"stepQuantity": 0
},
"available": false,
"basicPrice": {
"value": 0,
"currencyId": "RUR",
"discountBase": 0,
"updatedAt": "2022-12-29T18:02:01Z"
},
"campaignPrice": {
"value": 0,
"discountBase": 0,
"currencyId": "RUR",
"vat": 0,
"updatedAt": "2022-12-29T18:02:01Z"
},
"status": "PUBLISHED",
"errors": [
{
"message": "string",
"comment": "string"
}
],
"warnings": [
{
"message": "string",
"comment": "string"
}
]
}
]
}
}
Name |
Description |
result |
Type: GetCampaignOffersResultDTO Список товаров в заданном магазине. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
GetCampaignOffersResultDTO
Список товаров в заданном магазине.
Name |
Description |
offers* |
Type: GetCampaignOfferDTO[] Страница списка товаров. |
paging |
Type: ScrollingPagerDTO Информация о страницах результатов. |
GetCampaignOfferDTO
Параметры размещения товара в магазине.
Name |
Description |
offerId* |
Type: string Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
Что такое SKU и как его назначать Min length: Max length: Pattern: |
available |
Type: boolean Есть ли товар в продаже. |
basicPrice |
Type: GetPriceWithDiscountDTO Основная цена на товар. |
campaignPrice |
Type: GetPriceWithVatDTO Цена, установленная в магазине. |
errors |
Type: OfferErrorDTO[] Ошибки, препятствующие размещению товара на витрине.
|
quantum |
Type: QuantumDTO Настройка продажи квантами. Что это значит? |
status |
Type: OfferCampaignStatusType Статус товара. Enum: |
warnings |
Type: OfferErrorDTO[] Предупреждения, не препятствующие размещению товара на витрине.
|
ScrollingPagerDTO
Информация о страницах результатов.
Name |
Description |
nextPageToken |
Type: string Идентификатор следующей страницы результатов. |
prevPageToken |
Type: string Идентификатор предыдущей страницы результатов. |
GetPriceWithDiscountDTO
Цена с указанием скидки и времени последнего обновления.
Name |
Description |
updatedAt* |
Type: string<date-time> Время последнего обновления. |
currencyId |
Type: CurrencyType Валюта. При передаче валюты указывайте Enum: |
discountBase |
Type: number Цена до скидки. Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%. Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар. |
value |
Type: number Значение. |
GetPriceWithVatDTO
Цена с указанием ставки НДС и времени последнего обновления.
Name |
Description |
updatedAt* |
Type: string<date-time> Время последнего обновления. |
currencyId |
Type: CurrencyType Валюта, в которой указана цена на товар. Возможно только значение Enum: |
discountBase |
Type: number Цена на товар без скидки. Число должно быть целым. Вы можете указать цену со скидкой от 5 до 99%. Передавайте этот параметр при каждом обновлении цены, если предоставляете скидку на товар. |
value |
Type: number Цена на товар. |
vat |
Type: integer<int32> Идентификатор ставки НДС, применяемой для товара:
Если параметр не указан, используется ставка НДС, установленная в кабинете. |
OfferErrorDTO
Сообщение об ошибке, связанной с размещением товара.
Name |
Description |
comment |
Type: string Пояснение. |
message |
Type: string Тип ошибки. |
QuantumDTO
Настройка продажи квантами.
Чтобы сбросить установленные ранее значения, передайте пустой параметр quantum
.
Пример
{
"offers": [
{
"offerId": "08e35dc1-89a2-11e3-8055-0015e9b8c48d",
"quantum": {}
}
]
}
Name |
Description |
minQuantity |
Type: integer<int32> Минимальное количество единиц товара в заказе. Например, если указать 10, покупатель сможет добавить в корзину не меньше 10 единиц. ⚠️ Если количество товара на складе меньше заданного, ограничение не сработает и покупатель сможет его заказать. Min value: |
stepQuantity |
Type: integer<int32> На сколько единиц покупатель сможет увеличить количество товара в корзине. Например, если задать 5, покупатель сможет добавить к заказу только 5, 10, 15, ... единиц товара. ⚠️ Если количество товара на складе не дотягивает до кванта, ограничение не сработает и покупатель сможет заказать количество, не кратное кванту. Min value: Max value: |
CurrencyType
Коды валют. Возможные значения:
BYR
— белорусский рубль.KZT
— казахстанский тенге.RUR
— российский рубль.UAH
— украинская гривна.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
ApiErrorDTO
Общий формат ошибки.
Name |
Description |
code* |
Type: string Код ошибки. |
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |