Просмотр цен на указанные товары в магазине

Возвращает список цен на указанные товары в магазине.

Метод только для отдельных магазинов

Используйте этот метод, только если в кабинете установлены уникальные цены в отдельных магазинах.

Для просмотра базовых цен используйте POST businesses/{businessId}/offer-mappings.

⚙️ Лимит: рассчитывается по формуле

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-prices

Path parameters

Name

Description

campaignId*

Type: integer<int64>

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

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

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

Query parameters

Name

Description

page_token

Type: string

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

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

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

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

limit

Type: integer<int32>

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

Body

application/json
{
    "offerIds": [
        "string"
    ]
}

Name

Description

offerIds

Type: string[]

Список SKU.

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

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

  • page_token
  • limit


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

Разрешена любая последовательность длиной до 255 знаков.

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

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

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

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

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


Min length: 1
Max length: 255
Pattern: ^[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
Max items: 2000
Min items: 1

Responses

200 OK

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

Body

application/json
{
    "status": "OK",
    "result": {
        "offers": [
            {
                "offerId": "string",
                "price": {
                    "value": 0,
                    "discountBase": 0,
                    "currencyId": "RUR",
                    "vat": 0
                },
                "updatedAt": "2022-12-29T18:02:01Z"
            }
        ],
        "paging": {
            "nextPageToken": "string",
            "prevPageToken": "string"
        }
    }
}

Name

Description

status

Type: ApiResponseStatusType

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

result

Type: OfferPriceByOfferIdsListResponseDTO

Список цен.

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OfferPriceByOfferIdsListResponseDTO

Список цен.

Name

Description

offers

Type: OfferPriceByOfferIdsResponseDTO[]

Страница списка цен.
Информация об установленной цене.

paging

Type: ScrollingPagerDTO

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

OfferPriceByOfferIdsResponseDTO

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

Name

Description

offerId

Type: string

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

Разрешена любая последовательность длиной до 255 знаков.

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

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

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

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

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


Min length: 1
Max length: 255
Pattern: ^[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

price

Type: PriceDTO

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

updatedAt

Type: string<date-time>

Дата и время последнего обновления цены.

ScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

prevPageToken

Type: string

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

PriceDTO

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

Name

Description

value

Type: number

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

discountBase

Type: number

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

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

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

currencyId

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

Type: integer<int32>

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

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

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

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

Description

status

Type: ApiResponseStatusType

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

errors

Type: ApiErrorDTO[]

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

ApiErrorDTO

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

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

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

401 Unauthorized

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

Body

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

Name

Description

status

Type: ApiResponseStatusType

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

errors

Type: ApiErrorDTO[]

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

403 Forbidden

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

Body

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

Name

Description

status

Type: ApiResponseStatusType

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

errors

Type: ApiErrorDTO[]

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

404 Not Found

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

Body

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

Name

Description

status

Type: ApiResponseStatusType

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

errors

Type: ApiErrorDTO[]

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

420 Method Failure

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

Body

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

Name

Description

status

Type: ApiResponseStatusType

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

errors

Type: ApiErrorDTO[]

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

500 Internal Server Error

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

Body

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

Name

Description

status

Type: ApiResponseStatusType

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

errors

Type: ApiErrorDTO[]

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