Отчет по товарам

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

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

Возвращает подробный отчет по товарам, которые вы разместили на Маркете. С помощью отчета вы можете узнать, например, об остатках на складе, об условиях хранения ваших товаров и т. д.

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

Request

POST

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/skus

Path parameters

Name

Description

campaignId*

Type: integer<int64>

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

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

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

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

Min value: 1

Body

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

Name

Description

shopSkus*

Type: string[]

Список ваших идентификаторов SKU.
Ваш 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: 500

Unique items  

Responses

200 OK

Отчет по товарам.

Body

application/json
{
    "status": "OK",
    "result": {
        "shopSkus": [
            {
                "shopSku": "string",
                "marketSku": 0,
                "name": "string",
                "price": 0,
                "categoryId": 0,
                "categoryName": "string",
                "weightDimensions": {
                    "length": 0,
                    "width": 0,
                    "height": 0,
                    "weight": 0
                },
                "warehouses": [
                    {
                        "id": 0,
                        "name": "string",
                        "stocks": [
                            {
                                "type": "FIT",
                                "count": 0
                            }
                        ]
                    }
                ],
                "tariffs": [
                    {
                        "type": "AGENCY_COMMISSION",
                        "percent": 0,
                        "amount": 0,
                        "currency": "RUR",
                        "parameters": [
                            {
                                "name": "string",
                                "value": "string"
                            }
                        ]
                    }
                ],
                "pictures": [
                    "string"
                ]
            }
        ]
    }
}

Name

Description

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: GoodsStatsDTO

Отчет по товарам.

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GoodsStatsDTO

Отчет по товарам.

Name

Description

shopSkus*

Type: GoodsStatsGoodsDTO[]

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

GoodsStatsGoodsDTO

Информация о товаре.

Name

Description

categoryId

Type: integer<int64>

Идентификатор категории товара на Маркете.

categoryName

Type: string

Название категории товара на Маркете.

marketSku

Type: integer<int64>

Идентификатор карточки товара на Маркете.

Min value: 1

name

Type: string

Название товара.

pictures

Type: string[]

Ссылки (URL) изображений товара в хорошем качестве.

Min length: 1

Max length: 2000

Min items: 1

Unique items  

price

Type: number

Цена товара в валюте, которая установлена в кабинете продавца на Маркете.

shopSku

Type: string

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

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

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

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

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

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

Min length: 1

Max length: 255

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

tariffs

Type: TariffDTO[]

Информация о тарифах, по которым нужно заплатить за услуги Маркета.

По некоторым услугам могут возвращаться несколько разных стоимостей. Например, в модели FBS стоимость услуги SORTING (обработка заказа) зависит от способа отгрузки и количества заказов в отгрузке. Подробнее о тарифах на услуги читайте в Справке Маркета для продавцов.
Информация о тарифах, по которым нужно заплатить за услуги Маркета.

Min items: 1

warehouses

Type: GoodsStatsWarehouseDTO[]

Информация о складах, на которых хранится товар.

Параметр не приходит, если товара нет ни на одном складе.
Информация о складе.

Min items: 1

weightDimensions

Type: GoodsStatsWeightDimensionsDTO

Информация о весе и габаритах товара. Если товар уже привязан к карточке (marketSku), в ответе вернутся габариты из карточки Маркета, а не размеры, которые вы передаете.

TariffDTO

Информация о тарифах, по которым нужно заплатить за услуги Маркета.

Name

Description

amount*

Type: number

Значение тарифа.

currency*

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

parameters*

Type: TariffParameterDTO[]

Параметры расчета тарифа.
Детали расчета конкретной услуги Маркета.

type*

Type: TariffType

Услуга Маркета, за которую начисляется тариф.

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

percent

⦸

Type: number

Значение тарифа в процентах.

GoodsStatsWarehouseDTO

Информация о складе.

Name

Description

stocks*

Type: WarehouseStockDTO[]

Информация об остатках товаров на складе.
Информация об остатках товара.

id

Type: integer<int64>

Идентификатор склада.

name

Type: string

Название склада.

GoodsStatsWeightDimensionsDTO

Информация о весе и габаритах товара.

Если товар уже привязан к карточке (marketSku), в ответе вернутся габариты из карточки Маркета, а не размеры, которые вы передаете.

Name

Description

height

Type: number

Высота товара в сантиметрах.

length

Type: number

Длина товара в сантиметрах.

weight

Type: number

Вес товара в килограммах.

width

Type: number

Ширина товара в сантиметрах.

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

TariffParameterDTO

Детали расчета конкретной услуги Маркета.

Name

Description

name*

Type: string

Название параметра.

value*

Type: string

Значение параметра.

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

Description

TariffType

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

WarehouseStockDTO

Информация об остатках товара.

Name

Description

count*

Type: integer<int64>

Значение остатков.

type*

Type: WarehouseStockType

Тип остатков.

Enum: FIT, FREEZE, AVAILABLE, QUARANTINE, UTILIZATION, DEFECT, EXPIRED

WarehouseStockType

Тип остатков товаров на складе:

  • AVAILABLE (соответствует типу «Доступный к заказу» в отчете «Остатки на складе» в кабинете продавца на Маркете) — товар, доступный для продажи.

  • DEFECT (соответствует типу «Брак») — товар с браком.

  • EXPIRED (соответствует типу «Просрочен») — товар с истекшим сроком годности.

  • FIT (соответствует типу «Годный») — товар, который доступен для продажи или уже зарезервирован.

  • FREEZE — товар, который зарезервирован для заказов.

  • QUARANTINE (соответствует типу «Карантин») — товар, временно недоступный для продажи (например, товар перемещают из одного помещения склада в другое).

  • UTILIZATION — товар, который будет утилизирован.

Type

Description

WarehouseStockType

Enum: FIT, FREEZE, AVAILABLE, QUARANTINE, UTILIZATION, DEFECT, EXPIRED

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.

Предыдущая
Отчет по схождению с закрывающими документами
Следующая
Отчет «Цены»