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

Возвращает список товаров, размещенных в заданном магазине. Для каждого товара указываются параметры размещения.

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

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

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

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

Query parameters

Name

Type

Description

page_token

string

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

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

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

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

limit

integer<int32>

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

Body

application/json
{
    "offerIds": [
        "string"
    ],
    "statuses": [
        "PUBLISHED"
    ],
    "categoryIds": [
        0
    ],
    "vendorNames": [
        "string"
    ],
    "tags": [
        "string"
    ]
}

Name

Type

Description

offerIds

string[]

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

⚠️ Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым.
Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы . , / \ ( ) [ ] - = _

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

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

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

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

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


Min length: 1
Max length: 80

statuses

OfferCampaignStatusType[]

Фильтр по статусам товаров.
Статус товара:

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

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


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

categoryIds

integer[]

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

vendorNames

string[]

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

tags

string[]

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

OfferCampaignStatusType

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

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

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

Type

Description

OfferCampaignStatusType

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

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

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

result

GetCampaignOffersResultDTO

Список товаров в заданном магазине.

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetCampaignOffersResultDTO

Список товаров в заданном магазине.

Name

Type

Description

paging

ScrollingPagerDTO

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

offers

GetCampaignOfferDTO[]

Страница списка товаров.
Параметры размещения товара в магазине.
Информация о новой цене на товар.

ScrollingPagerDTO

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

Name

Type

Description

nextPageToken

string

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

prevPageToken

string

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

GetCampaignOfferDTO

Параметры размещения товара в магазине.

Name

Type

Description

offerId*

string

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

Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы . , / \ ( ) [ ] - = _

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

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

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

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

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


Min length: 1
Max length: 80

quantum

QuantumDTO

Настройка продажи квантами. Что это значит?

available

boolean

Есть ли товар в продаже.

basicPrice

GetPriceWithDiscountDTO

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

campaignPrice

GetPriceWithVatDTO

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

status

OfferCampaignStatusType

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


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

errors

OfferErrorDTO[]

Ошибки, препятствующие размещению товара на витрине.
Сообщение об ошибке, связанной с размещением товара.

warnings

OfferErrorDTO[]

Предупреждения, не препятствующие размещению товара на витрине.
Сообщение об ошибке, связанной с размещением товара.

QuantumDTO

Настройка продажи квантами.

Чтобы сбросить установленные ранее значения, передайте пустой параметр quantum.

Пример
{
  "offers": [
    {
      "offerId": "08e35dc1-89a2-11e3-8055-0015e9b8c48d",
      "quantum": {}
    }
  ]
}

Name

Type

Description

minQuantity

integer<int32>

Минимальное количество единиц товара в заказе. Например, если указать 10, покупатель сможет добавить в корзину не меньше 10 единиц.

⚠️ Если количество товара на складе меньше заданного, ограничение не сработает и покупатель сможет его заказать.

stepQuantity

integer<int32>

На сколько единиц покупатель сможет увеличить количество товара в корзине.

Например, если задать 5, покупатель сможет добавить к заказу только 5, 10, 15, ... единиц товара.

⚠️ Если количество товара на складе не дотягивает до кванта, ограничение не сработает и покупатель сможет заказать количество, не кратное кванту.

GetPriceWithDiscountDTO

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

Name

Type

Description

value

number

Значение.

currencyId

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

number

Цена до скидки.

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

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

updatedAt*

string<date-time>

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

GetPriceWithVatDTO

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

Name

Type

Description

value

number

Цена на товар.

discountBase

number

Цена на товар без скидки.

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

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

currencyId

CurrencyType

Валюта, в которой указана цена на товар.

Возможно только значение 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

vat

integer<int32>

Идентификатор ставки НДС, применяемой для товара:

  • 2 — 10%.
  • 5 — 0%.
  • 6 — не облагается НДС.
  • 7 — 20%.

Если параметр не указан, используется ставка НДС, установленная в кабинете.

updatedAt*

string<date-time>

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

OfferErrorDTO

Сообщение об ошибке, связанной с размещением товара.

Name

Type

Description

message

string

Тип ошибки.

comment

string

Пояснение.

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

400 Bad Request

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

ApiErrorDTO

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

Name

Type

Description

code*

string

Код ошибки.

message

string

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

401 Unauthorized

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

403 Forbidden

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

404 Not Found

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

420 Method Failure

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

500 Internal Server Error

Внутренняя ошибка сервера.

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.
Предыдущая
Просмотр цен
Следующая
Удаление товаров
В этой статье: