Информация о товарах, которые размещены в заданном магазине

Метод доступен для всех моделей.

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

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

⚙️ Лимит: 10 000 товаров в минуту

Request

POST

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

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

Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:

  • Модули и API → блок Передача данных Маркету.
  • Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

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

Min value: 1
Example: 20

page_token

Type: string

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

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

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

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

Body

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

Name

Description

categoryIds

Type: integer[]

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

Min items: 1

Unique items  

offerIds

Type: string[]

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

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

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

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

  • page_token
  • limit


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

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

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

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

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

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

Min length: 1

Max length: 255

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

Min items: 1

Max items: 200

Unique items  

statuses

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

Min items: 1

Unique items  

tags

Type: string[]

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

Min items: 1

Unique items  

vendorNames

Type: string[]

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

Min items: 1

Unique items  

OfferCampaignStatusType

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

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

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

Type

Description

OfferCampaignStatusType

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

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

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

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

Enum: OK, ERROR

GetCampaignOffersResultDTO

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

Name

Description

offers*

Type: GetCampaignOfferDTO[]

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

paging

Type: ScrollingPagerDTO

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

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetCampaignOfferDTO

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

Name

Description

offerId*

Type: string

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

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

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

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

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

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

Min length: 1

Max length: 255

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

available

⦸

Type: boolean

Вместо него используйте методы скрытия товаров с витрины

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

basicPrice

Type: GetPriceWithDiscountDTO

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

campaignPrice

Type: GetPriceWithVatDTO

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

errors

Type: OfferErrorDTO[]

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

Min items: 1

quantum

⦸

Type: QuantumDTO

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

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

warnings

Type: OfferErrorDTO[]

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

Min items: 1

ScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

prevPageToken

Type: string

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

GetPriceWithDiscountDTO

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

Name

Description

updatedAt*

Type: string<date-time>

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

currencyId

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

discountBase

Type: number

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

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

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

Min value (exclusive): 0

value

Type: number

Цена товара.

Min value (exclusive): 0

GetPriceWithVatDTO

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

Name

Description

updatedAt*

Type: string<date-time>

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

currencyId

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

discountBase

Type: number

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

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

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

Min value (exclusive): 0

value

Type: number

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

Min value (exclusive): 0

vat

Type: integer<int32>

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

  • 2 — НДС 10%. Например, используется при реализации отдельных продовольственных и медицинских товаров.
  • 5 — НДС 0%. Например, используется при продаже товаров, вывезенных в таможенной процедуре экспорта, или при оказании услуг по международной перевозке товаров.
  • 6 — НДС не облагается, используется только для отдельных видов услуг.
  • 7 — НДС 20%. Основной НДС с 2019 года.
  • 10 — НДС 5%. НДС для упрощенной системы налогообложения (УСН).
  • 11 — НДС 7%. НДС для упрощенной системы налогообложения (УСН).

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

Для продавцов Market Yandex Go недоступна передача и получение НДС.

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

stepQuantity

Type: integer<int32>

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

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

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

Min value: 1

Max value: 100

CurrencyType

Коды валют:

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

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

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

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[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

403 Forbidden

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

404 Not Found

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

420 Method Failure

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

500 Internal Server Error

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

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

Предыдущая
В кабинете
Следующая
В кабинете