Отчет по товарам
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- offers-and-cards-management — Управление товарами и карточками
- offers-and-cards-management:read-only — Просмотр товаров и карточек
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.
| ⚙️ Лимит: 5 000 товаров в минуту |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/skus
Path parameters
|
Name |
Description |
|
campaignId |
Type: integer Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
⚠️ Не путайте его с:
Min value: |
Body
application/json
{
"shopSkus": [
"example"
]
}
|
Name |
Description |
|
shopSkus |
Type: ShopSku[] Список ваших идентификаторов SKU. Min items: Max 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
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"
}
MarketSku
Идентификатор карточки товара на Маркете.
Type: integer
Min value: 1
GoodsStatsWeightDimensionsDTO
Информация о весе и габаритах товара.
Если товар уже привязан к карточке (marketSku), в ответе вернутся габариты из карточки Маркета, а не размеры, которые вы передаете.
|
Name |
Description |
|
height |
Type: number Высота товара в сантиметрах. |
|
length |
Type: number Длина товара в сантиметрах. |
|
weight |
Type: number Вес товара в килограммах. |
|
width |
Type: number Ширина товара в сантиметрах. |
Example
{
"length": 0.5,
"width": 0.5,
"height": 0.5,
"weight": 0.5
}
WarehouseStockType
Тип остатков товаров на складе:
-
AVAILABLE(соответствует типу «Доступный к заказу» в отчете «Остатки на складе» в кабинете продавца на Маркете) — товар, доступный для продажи. -
DEFECT(соответствует типу «Брак») — товар с браком. -
EXPIRED(соответствует типу «Просрочен») — товар с истекшим сроком годности. -
FIT(соответствует типу «Годный») — товар, который доступен для продажи или уже зарезервирован. -
FREEZE— товар, который зарезервирован для заказов. -
QUARANTINE(соответствует типу «Карантин») — товар, временно недоступный для продажи (например, товар перемещают из одного помещения склада в другое). -
UTILIZATION— товар, который будет утилизирован.
Type: string
Enum: FIT, FREEZE, AVAILABLE, QUARANTINE, UTILIZATION, DEFECT, EXPIRED
WarehouseStockDTO
Информация об остатках товара.
|
Name |
Description |
|
count |
Type: integer Значение остатков. |
|
type |
Type: WarehouseStockType Тип остатков. Тип остатков товаров на складе:
Enum: |
Example
{
"type": "FIT",
"count": 0
}
GoodsStatsWarehouseDTO
Информация о складе.
|
Name |
Description |
|
stocks |
Type: WarehouseStockDTO[] Информация об остатках товаров на складе. Example
|
|
id |
Type: integer Идентификатор склада. |
|
name |
Type: string Название склада. Example: |
Example
{
"id": 0,
"name": "example",
"stocks": [
{
"type": "FIT",
"count": 0
}
]
}
TariffType
Услуга Маркета или дополнительный тариф к услуге размещения:
-
AGENCY_COMMISSION— прием платежа покупателя. -
PAYMENT_TRANSFER— перевод платежа покупателя. -
STORAGE— хранение товара на складе Маркета в течение суток. -
SURPLUS— хранение излишков на складе Маркета. -
WITHDRAW— вывоз товара со склада Маркета. -
FEE— размещение товара на Маркете. -
DELIVERY_TO_CUSTOMER— доставка покупателю. -
CROSSREGIONAL_DELIVERY— доставка в федеральный округ, город или населенный пункт. -
CROSSREGIONAL_DELIVERY_RETURN— доставка невыкупов и возвратов. -
DISPOSAL— утилизация. -
SORTING_CENTER_STORAGE— хранение невыкупов и возвратов. -
EXPRESS_DELIVERY— экспресс-доставка покупателю. -
FF_XDOC_SUPPLY_BOX— поставка товара через транзитный склад (за короб). -
FF_XDOC_SUPPLY_PALLET— поставка товара через транзитный склад (за палету). -
SORTING— обработка заказа. -
MIDDLE_MILE— средняя миля. -
RETURN_PROCESSING— обработка невыкупов и возвратов. -
EXPRESS_CANCELLED_BY_PARTNER— отмена заказа с экспресс-доставкой. -
CROSSBORDER_DELIVERY— доставка из-за рубежа. -
INTAKE_SORTING_BULKY_CARGO— сортировка заказов с крупногабаритными товарами, которые Маркет забрал со склада продавца. -
INTAKE_SORTING_SMALL_GOODS— сортировка заказов с малогабаритными товарами, которые Маркет забрал со склада продавца. -
INTAKE_SORTING_DAILY— организация забора заказов со склада продавца. -
FF_STORAGE_BILLING— хранение товаров на складе. -
CANCELLED_ORDER_FEE_QI— отмена заказа по вине продавца. -
LATE_ORDER_EXECUTION_FEE_QI— несвоевременная отгрузка или доставка. -
VOLUME_STORAGE— стоимость хранения товара на складе — из расчёта за один кубический метр в сутки. -
GOODS_ACCEPTANCE— окончательная приемка товара на складе. -
CARGO_ACCEPTANCE— первичная приемка товара на складе. -
ORDER_PROCESSING— обработка заказа. -
WITHDRAW_EXTERNAL— отгрузка на внешний маркетплейс.
Подробнее об услугах Маркета читайте в Справке Маркета для продавцов.
Type: string
Enum: AGENCY_COMMISSION, PAYMENT_TRANSFER, STORAGE, WITHDRAW, SURPLUS, FEE, DELIVERY_TO_CUSTOMER, CROSSREGIONAL_DELIVERY, CROSSREGIONAL_DELIVERY_RETURN, DISPOSAL, SORTING_CENTER_STORAGE, EXPRESS_DELIVERY, FF_XDOC_SUPPLY_BOX, FF_XDOC_SUPPLY_PALLET, SORTING, MIDDLE_MILE, RETURN_PROCESSING, EXPRESS_CANCELLED_BY_PARTNER, CROSSBORDER_DELIVERY, INTAKE_SORTING_BULKY_CARGO, INTAKE_SORTING_SMALL_GOODS, INTAKE_SORTING_DAILY, FF_STORAGE_BILLING, CANCELLED_ORDER_FEE_QI, LATE_ORDER_EXECUTION_FEE_QI, VOLUME_STORAGE, GOODS_ACCEPTANCE, CARGO_ACCEPTANCE, ORDER_PROCESSING, WITHDRAW_EXTERNAL
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
TariffParameterDTO
Детали расчета конкретной услуги Маркета.
|
Name |
Description |
|
name |
Type: string Название параметра. Example: |
|
value |
Type: string Значение параметра. Example: |
Example
{
"name": "example",
"value": "example"
}
TariffDTO
Информация о тарифах, по которым нужно заплатить за услуги Маркета.
|
Name |
Description |
|
amount |
Type: number Значение тарифа. |
|
currency |
Type: CurrencyType Валюта, в которой указано значение тарифа. Коды валют:
Enum: |
|
parameters |
Type: TariffParameterDTO[] Параметры расчета тарифа. Example
|
|
type |
Type: TariffType Услуга Маркета, за которую начисляется тариф. Услуга Маркета или дополнительный тариф к услуге размещения:
Подробнее об услугах Маркета читайте в Справке Маркета для продавцов. Enum: |
|
percent |
Type: number Значение тарифа в процентах. |
Example
{
"type": "AGENCY_COMMISSION",
"percent": 0.5,
"amount": 0.5,
"currency": "RUR",
"parameters": [
{
"name": "example",
"value": "example"
}
]
}
Url
Type: string
Min length: 1
Max length: 2000
Example: example
GoodsStatsGoodsDTO
Информация о товаре.
|
Name |
Description |
|
categoryId |
Type: integer Идентификатор категории товара на Маркете. |
|
categoryName |
Type: string Название категории товара на Маркете. Example: |
|
marketSku |
Type: MarketSku SKU на Маркете — идентификатор карточки товара на Маркете. Идентификатор карточки товара на Маркете. Min value: Example: |
|
name |
Type: string Название товара. Example: |
|
pictures |
Type: Url[] | null Ссылки (URL) изображений товара в хорошем качестве. Min items: Unique items: Example
|
|
price |
Type: number Цена товара в валюте, которая установлена в кабинете продавца на Маркете. |
|
shopSku |
Type: ShopSku Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Важно Пробельные символы в начале и конце значения автоматически удаляются. Например, Что такое SKU и как его назначать Min length: Max length: Pattern: Example: |
|
tariffs |
Type: TariffDTO[] | null Информация о тарифах, по которым нужно заплатить за услуги Маркета. По некоторым услугам могут возвращаться несколько разных стоимостей. Например, в модели FBS стоимость услуги Min items: Example
|
|
warehouses |
Type: GoodsStatsWarehouseDTO[] | null Информация о складах, на которых хранится товар. Параметр не приходит, если товара нет ни на одном складе. Min items: Example
|
|
weightDimensions |
Type: GoodsStatsWeightDimensionsDTO Информация о весе и габаритах товара.
Если товар уже привязан к карточке ( Информация о весе и габаритах товара. Если товар уже привязан к карточке ( Example
|
Example
{
"shopSku": "example",
"marketSku": 1,
"name": "example",
"price": 0.5,
"categoryId": 0,
"categoryName": "example",
"weightDimensions": {
"length": 0.5,
"width": 0.5,
"height": 0.5,
"weight": 0.5
},
"warehouses": [
{
"id": 0,
"name": "example",
"stocks": [
{
"type": "FIT",
"count": 0
}
]
}
],
"tariffs": [
{
"type": "AGENCY_COMMISSION",
"percent": 0.5,
"amount": 0.5,
"currency": "RUR",
"parameters": [
{
"name": "example",
"value": "example"
}
]
}
],
"pictures": [
"example"
]
}
GoodsStatsDTO
Отчет по товарам.
|
Name |
Description |
|
shopSkus |
Type: GoodsStatsGoodsDTO[] Список товаров. Example
|
Example
{
"shopSkus": [
{
"shopSku": "example",
"marketSku": 1,
"name": "example",
"price": 0.5,
"categoryId": 0,
"categoryName": "example",
"weightDimensions": {
"length": 0.5,
"width": 0.5,
"height": 0.5,
"weight": 0.5
},
"warehouses": [
{
"id": 0,
"name": "example",
"stocks": [
null
]
}
],
"tariffs": [
{
"type": "AGENCY_COMMISSION",
"percent": 0.5,
"amount": 0.5,
"currency": "RUR",
"parameters": [
null
]
}
],
"pictures": [
"example"
]
}
]
}
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: []
headers: []
body: |-
{
"shopSkus": [
"example"
]
}
schema:
description: Запрос отчета по товарам.
type: object
required:
- shopSkus
properties:
shopSkus:
description: |
Список ваших идентификаторов SKU.
type: array
uniqueItems: 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: 500
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}/stats/skus
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.