Описание API Аналитика

Сервис предоставляет публичный API для получения аналитических данных. С помощью этих методов вы можете получать аналитические отчёты. Часть методов доступна только с подпиской на расширенную аналитику Джем.

Воронка продаж

Таймзоны

Формат IANA, актуальный список можно посмотреть здесь.

Получение статистики КТ за выбранный период, по nmID/предметам/брендам/тегам

Получение статистики КТ за выбранный период, по nmID/предметам/брендам/тегам.
Поля brandNames,objectIDs, tagIDs, nmIDs могут быть пустыми, тогда в ответе идут все карточки продавца.
При выборе нескольких полей в ответ приходят данные по карточкам, у которых есть все выбранные поля. Работает с пагинацией.
Можно получить отчёт максимум за последний год (365 дней).
Также в данных, где предоставляется информация по предыдущему периоду:

В previousPeriod данные за такой же период, что и в selectedPeriod.
Если дата начала previousPeriod раньше, чем год назад от текущей даты, она будет приведена к виду: previousPeriod.start = текущая дата - 365 дней.

Максимум 3 запроса в минуту.

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

brandNames	Array of strings Название бренда
objectIDs	Array of integers <int32> [ items <int32 > ] Идентификатор предмета
tagIDs	Array of integers <int32> [ items <int32 > ] Идентификатор тега
nmIDs	Array of integers <int32> [ items <int32 > ] Артикул WB
timezone	string Временная зона. Если не указано, то по умолчанию используется Europe/Moscow.
required	object Период
	object Параметры сортировки. Если не указано, то по умолчанию используется значение "openCard" и сортировка по убыванию. Все виды сортировки `field`: `openCard` — по открытию карточки (переход на страницу товара) `addToCart` — по добавлениям в корзину `orders` — по кол-ву заказов `avgRubPrice` — по средней цене в рублях `ordersSumRub` — по сумме заказов в рублях `stockMpQty` — по кол-ву остатков маркетплейса шт. `stockWbQty` — по кол-ву остатков на складе шт. `cancelSumRub` — сумме возвратов в рублях `cancelCount` — по кол-ву возвратов `buyoutCount` — по кол-ву выкупов `buyoutSumRub` — по сумме выкупов
page required	integer <int32> Страница

Responses

Response Schema: application/json

	object
error	boolean Флаг ошибки
errorText	string Описание ошибки
	Array of objects Дополнительные ошибки

Request samples

Payload

Content type

application/json

{"brandNames": ["Some"
],
"objectIDs": [358
],
"tagIDs": [123
],
"nmIDs": [1234567
],
"timezone": "Europe/Moscow",
"period": {"begin": "2023-06-01 20:05:32",
"end": "2024-03-01 20:05:32"
},
"orderBy": {"field": "ordersSumRub",
"mode": "asc"
},
"page": 1
}

Response samples

Content type

application/json

{"data": {"page": 1,
"isNextPage": true,
"cards": [{"nmID": 1234567,
"vendorCode": "supplierVendor",
"brandName": "Some",
"tags": [{"id": 123,
"name": "Sale"
}
],
"object": {"id": 447,
"name": "Кондиционеры для волос"
},
"statistics": {"selectedPeriod": {"begin": "2023-06-01 20:05:32",
"end": "2024-03-01 20:05:32",
"openCardCount": 0,
"addToCartCount": 0,
"ordersCount": 0,
"ordersSumRub": 0,
"buyoutsCount": 0,
"buyoutsSumRub": 0,
"cancelCount": 0,
"cancelSumRub": 0,
"avgPriceRub": 0,
"avgOrdersCountPerDay": 0,
"conversions": {"addToCartPercent": 0,
"cartToOrderPercent": 0,
"buyoutsPercent": 0
}
},
"previousPeriod": {"begin": "2023-05-07 20:05:31",
"end": "2023-06-01 20:05:31",
"openCardCount": 0,
"addToCartCount": 0,
"ordersCount": 1,
"ordersSumRub": 1262,
"buyoutsCount": 1,
"buyoutsSumRub": 1262,
"cancelCount": 0,
"cancelSumRub": 0,
"avgPriceRub": 1262,
"avgOrdersCountPerDay": 0.04,
"conversions": {"addToCartPercent": 0,
"cartToOrderPercent": 0,
"buyoutsPercent": 100
}
},
"periodComparison": {"openCardDynamics": 0,
"addToCartDynamics": 0,
"ordersCountDynamics": -100,
"ordersSumRubDynamics": -100,
"buyoutsCountDynamics": -100,
"buyoutsSumRubDynamics": -100,
"cancelCountDynamics": 0,
"cancelSumRubDynamics": 0,
"avgOrdersCountPerDayDynamics": 0,
"avgPriceRubDynamics": -100,
"conversions": {"addToCartPercent": 0,
"cartToOrderPercent": 0,
"buyoutsPercent": -100
}
}
},
"stocks": {"stocksMp": 0,
"stocksWb": 0
}
}
]
},
"error": true,
"errorText": "",
"additionalErrors": [{"field": "string",
"description": "string"
}
]
}

Получение статистики КТ за период, сгруппированный по предметам, брендам и тегам

Получение статистики КТ за период, сгруппированный по предметам, брендам и тегам.
Поля brandNames, objectIDs, tagIDs могут быть пустыми, тогда группировка происходит по всем карточкам продавца.
Можно получить отчёт максимум за последний год (365 дней).
Также в данных, где предоставляется информация по предыдущему периоду:

В previousPeriod данные за такой же период, что и в selectedPeriod.
Если дата начала previousPeriod раньше, чем год назад от текущей даты, она будет приведена к виду: previousPeriod.start = текущая дата - 365 дней.

Максимум 3 запроса в минуту.

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

objectIDs	Array of integers <int32> [ items <int32 > ] Идентификатор предмета
brandNames	Array of strings Название бренда
tagIDs	Array of integers <int32> [ items <int32 > ] Идентификатор тега
timezone	string Временная зона. Если не указано, то по умолчанию используется Europe/Moscow.
required	object Период
	object Параметры сортировки. Если не указано, то по умолчанию используется значение "openCard" и сортировка по убыванию. Все виды сортировки `field`: `openCard` — по открытию карточки (переход на страницу товара) `addToCart` — по добавлениям в корзину `orders` — по кол-ву заказов `avgRubPrice` — по средней цене в рублях `ordersSumRub` — по сумме заказов в рублях `stockMpQty` — по кол-ву остатков маркетплейса шт. `stockWbQty` — по кол-ву остатков на складе шт.
page required	integer <int32> Страница

Responses

Response Schema: application/json

	object
error	boolean Флаг ошибки
errorText	string Описание ошибки
	Array of objects Дополнительные ошибки

Request samples

Payload

Content type

application/json

{"objectIDs": [358
],
"brandNames": ["Some"
],
"tagIDs": [123
],
"timezone": "Europe/Moscow",
"period": {"begin": "2023-10-04 20:05:32",
"end": "2024-03-01 20:05:32"
},
"orderBy": {"field": "ordersSumRub",
"mode": "asc"
},
"page": 1
}

Response samples

Content type

application/json

{"data": {"page": 1,
"isNextPage": true,
"groups": [{"brandName": "Some",
"tags": [{"id": 123,
"name": "Sale"
}
],
"object": {"id": 1668,
"name": "Воски для волос"
},
"statistics": {"selectedPeriod": {"begin": "2023-10-04 20:05:32",
"end": "2024-03-01 20:05:32",
"openCardCount": 0,
"addToCartCount": 0,
"ordersCount": 0,
"ordersSumRub": 0,
"buyoutsCount": 0,
"buyoutsSumRub": 0,
"cancelCount": 0,
"cancelSumRub": 0,
"avgPriceRub": 0,
"avgOrdersCountPerDay": 0,
"conversions": {"addToCartPercent": 0,
"cartToOrderPercent": 0,
"buyoutsPercent": 0
}
},
"previousPeriod": {"begin": "2023-11-04 20:05:31",
"end": "2024-03-01 20:05:31",
"openCardCount": 466,
"addToCartCount": 72,
"ordersCount": 84,
"ordersSumRub": 127060.42,
"buyoutsCount": 69,
"buyoutsSumRub": 104898.42,
"cancelCount": 13,
"cancelSumRub": 0,
"avgPriceRub": 1562.65,
"avgOrdersCountPerDay": 0.72,
"conversions": {"addToCartPercent": 15.5,
"cartToOrderPercent": 116.7,
"buyoutsPercent": 84.1
}
},
"periodComparison": {"openCardDynamics": -100,
"addToCartDynamics": -100,
"ordersCountDynamics": -100,
"ordersSumRubDynamics": -100,
"buyoutsCountDynamics": -100,
"buyoutsSumRubDynamics": -100,
"cancelCountDynamics": 0,
"cancelSumRubDynamics": 0,
"avgOrdersCountPerDayDynamics": 0,
"avgPriceRubDynamics": -100,
"conversions": {"addToCartPercent": -100,
"cartToOrderPercent": -100,
"buyoutsPercent": -100
}
}
}
}
]
},
"error": true,
"errorText": "",
"additionalErrors": [{"field": "string",
"description": "string"
}
]
}

Получение статистики КТ по дням по выбранным nmID

Получение статистики КТ по дням по выбранным nmID. Можно получить отчёт максимум за последнюю неделю. Чтобы получать отчёты за период до года, подпишитесь на расширенную аналитику Джем.
Максимум 3 запроса в минуту.

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

nmIDs required	Array of integers <int32> [ items <int32 > ] Артикул Wildberries (максимум 20)
required	object Период
timezone	string Временная зона. Если не указано, то по умолчанию используется Europe/Moscow.
aggregationLevel	string Тип агрегации. Если не указано, то по умолчанию используется агрегация по дням. Доступные уровни агрегации `day`, `week`

Responses

Response Schema: application/json

	Array of objects
error	boolean Флаг ошибки
errorText	string Описание ошибки
	Array of objects Дополнительные ошибки

Request samples

Payload

Content type

application/json

{"nmIDs": [1234567
],
"period": {"begin": "2023-06-20",
"end": "2023-06-22"
},
"timezone": "Europe/Moscow",
"aggregationLevel": "day"
}

Response samples

Content type

application/json

{"data": [{"nmID": 1234567,
"imtName": "Наименование КТ",
"vendorCode": "supplierVendor",
"history": [{"dt": "2023-06-20",
"openCardCount": 26,
"addToCartCount": 1,
"ordersCount": 0,
"ordersSumRub": 0,
"buyoutsCount": 0,
"buyoutsSumRub": 0,
"buyoutPercent": 0,
"addToCartConversion": 3.8,
"cartToOrderConversion": 0
}
]
}
],
"error": true,
"errorText": "",
"additionalErrors": [{"field": "string",
"description": "string"
}
]
}

Получение статистики КТ по дням за период, сгруппированный по предметам, брендам и тегам

Получение статистики КТ по дням за период, сгруппированный по предметам, брендам и тегам.
Поля brandNames, objectIDs, tagIDs могут быть пустыми, тогда группировка происходит по всем карточкам продавца.
В запросе произведение количества предметов, брендов, тегов не должно быть больше 16. Можно получить отчёт максимум за последнюю неделю. Чтобы получать отчёты за период до года, подпишитесь на расширенную аналитику Джем.
Максимум 3 запроса в минуту.

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

objectIDs	Array of integers <int32> [ items <int32 > ] Идентификатор предмета
brandNames	Array of strings Название бренда
tagIDs	Array of integers <int32> [ items <int32 > ] Идентификатор тега
required	object Период
timezone	string Временная зона. Если не указано, то по умолчанию используется Europe/Moscow.
aggregationLevel	string Тип аггрегации. Если не указано, то по умолчанию используется агрегация по дням. Доступные уровни агрегации `day`, `week`

Responses

Response Schema: application/json

	Array of objects
error	boolean Флаг ошибки
errorText	string Описание ошибки
	Array of objects Дополнительные ошибки

Request samples

Payload

Content type

application/json

{"objectIDs": [358
],
"brandNames": ["Some"
],
"tagIDs": [123
],
"period": {"begin": "2023-06-21",
"end": "2023-06-23"
},
"timezone": "Europe/Moscow",
"aggregationLevel": "day"
}

Response samples

Content type

application/json

{"data": [{"object": {"id": 358,
"name": "Шампуни"
},
"brandName": "Some",
"tag": {"id": 123,
"name": "Sale"
},
"history": [{"dt": "2023-06-21",
"openCardCount": 0,
"addToCartCount": 0,
"ordersCount": 0,
"ordersSumRub": 0,
"buyoutsCount": 0,
"buyoutsSumRub": 0,
"buyoutPercent": 0,
"addToCartConversion": 0,
"cartToOrderConversion": 0
}
]
}
],
"error": true,
"errorText": "",
"additionalErrors": [{"field": "string",
"description": "string"
}
]
}

Воронка продаж (Джем)

Вы можете использовать эти методы только с подпиской Джем.

Чтобы получить отчёт:

Сгенерируйте его с помощью метода метода Создать отчёт.
Дождитесь, когда отчёт будет готов. Готовность можно узнать с помощью метода Получить список отчётов. Готовый отчёт хранится 48 часов, потом его нельзя будет получить.
Если вы получили статус FAILED, сгенерируйте отчёт повторно
Получите отчёт.

Можно получить отчёт максимум за год.

Максимальное количество генерируемых отчётов в сутки — 20.

Создать отчёт

Вы можете создать отчёт с группировкой:

по артикулам Wildberries (nmID);
по категориям, брендам и тегам.

В каждом из этих отчётов можно сгруппировать данные по дням, неделям или месяцам.

Максимум 3 запроса в минуту, при этом в сутки можно сгенерировать максимум 20 отчётов (считаются только успешные генерации).

Authorizations:

HeaderApiKey

Request Body schema: application/json

One of

id required	string <uuid> Идентификатор отчёта в UUID-формате. Генерируется продавцом самостоятельно
reportType required	string Тип отчёта — `DETAIL_HISTORY_REPORT`
userReportName	string Название отчёта (если не указано, сформируется автоматически)
	object Параметры отчёта

Responses

Response Schema: application/json

data	string Уведомление, что началась генерация отчёта
error	boolean Флаг ошибки
errorText	string Описание ошибки
	Array of objects Дополнительные ошибки

Request samples

Payload

Content type

application/json

Example

BySelectedNmID

По артикулам Wildberries (nmID)

{"id": "06eae887-9d9f-491f-b16a-bb1766fcb8d2",
"reportType": "DETAIL_HISTORY_REPORT",
"userReportName": "Card report",
"params": {"nmIDs": [1234567
],
"subjectIDs": [1234567
],
"brandNames": ["Name"
],
"tagIDs": [1234567
],
"startDate": "2023-06-21",
"endDate": "2023-06-23",
"timezone": "Europe/Moscow",
"aggregationLevel": "day",
"skipDeletedNm": false
}
}

Response samples

Content type

application/json

{"data": "Началось формирование файла/отчета",
"error": false,
"errorText": "",
"additionalErrors": null
}

Получить список отчётов

Максимум 3 запроса в минуту

Authorizations:

HeaderApiKey

query Parameters

filter[downloadIds]

Array of strings <uuid> [ items <uuid > ]

ID отчёта

Responses

Response Schema: application/json

	Array of objects
error	boolean Флаг ошибки
errorText	string Текст ошибки
	Array of objects

Response samples

Content type

application/json

{"data": [{"id": "06eae887-9d9f-491f-b16a-bb1766fcb8d2",
"createdAt": "2023-06-26 20:05:32",
"status": "SUCCESS",
"name": "Card report",
"size": 123,
"startDate": "2023-06-21",
"endDate": "2023-06-23"
}
],
"error": false,
"errorText": "string",
"additionalErrors": null
}

Сгенерировать отчёт повторно

Максимум 3 запроса в минуту

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

downloadId

string <uuid>

ID отчёта

Responses

Response Schema: application/json

data	string Уведомление, что началась повторная генерация отчёта
error	boolean Флаг ошибки
errorText	string Описание ошибки
	Array of objects Дополнительные ошибки

Request samples

Payload

Content type

application/json

{"downloadId": "06eea887-9d9f-491f-b16a-bb1766fcb8d2"
}

Response samples

Content type

application/json

{"data": "Началось переформирование файла/отчета",
"error": false,
"errorText": "",
"additionalErrors": null
}

Получить отчёт

Можно получить отчёт, который сгенерирован в последние 48 часов.
Отчет будет загружен внутри архива ZIP в формате CSV.

Максимум 3 запроса в минуту.

Authorizations:

HeaderApiKey

path Parameters

downloadId

required

string <uuid>

ID отчёта

Responses

Response Schema: text/csv

string <binary>

Описание полей в файле CSV:

name	type	format	description
nmID (только для `DETAIL_HISTORY_REPORT`)	integer	int32	Артикул Wildberries
dt	string	date	Дата
openCardCount	integer	int32	Переходы в карточку товара
addToCartCount	integer	int32	Положили в корзину, шт.
ordersCount	integer	int32	Заказали товаров, шт.
ordersSumRub	integer	int32	Заказали на сумму, ₽
buyoutsCount	integer	int32	Выкупили товаров, шт.
buyoutsSumRub	integer	int32	Выкупили на сумму, ₽
cancelCount	integer	int32	Отменили товаров, шт.
cancelSumRub	integer	int32	Отменили на сумму, ₽
addToCartConversion	number	int32	Конверсия в корзину, % (Какой процент посетителей, открывших карточку товара, добавили товар в корзину)
cartToOrderConversion	integer	int32	Конверсия в заказ, % (Какой процент посетителей, добавивших товар в корзину, сделали заказ)
buyoutPercent	integer	int32	Процент выкупа, % (Какой процент посетителей, заказавших товар, его выкупили. Без учёта товаров, которые еще доставляются покупателю)

Response samples

Content type

text/csv

Example

BySelectedNmIDRes

nmID, dt, openCardCount, addToCartCount, ordersCount, ordersSumRub, buyoutsCount, buyoutsSumRub, cancelCount, cancelSumRub, addToCartConversion, cartToOrderConversion, buyoutPercent
70027655,2023-12-21,1,0,0,0,0,0,0,0,0,0,0
...
...
150317666,2023-12-21,2,0,0,0,0,0,0,0,0,0,0

Товары с обязательной маркировкой

Отчёт по товарам с обязательной маркировкой

Возвращает операции по маркируемым товарам. Максимум 10 запросов за 5 часов.

Authorizations:

HeaderApiKey

query Parameters

dateFrom required	string Начало отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры: `2023-12-01` `2023-12-01T23:59:59` `2023-12-01T00:00:00.12345` `2023-12-01T00:00:00`
dateTo required	string Конец отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры: `2023-12-01` `2023-12-01T23:59:59` `2023-12-01T00:00:00.12345` `2023-12-01T00:00:00`

Request Body schema: application/json
optional

countries

Array of strings

Items Enum: "AM" "BY" "KG" "KZ" "RU" "UZ"

Код стран по стандарту ISO 3166-2. Чтобы получить данные по всем странам, оставьте параметр пустым

Responses

Response Schema: application/json

object (models.ExciseReportResponse)

Request samples

Payload

Content type

application/json

{"countries": ["AM",
"RU"
]
}

Response samples

200
400

Content type

application/json

{"response": {"data": [{"name": "Россия",
"price": 100,
"currency_name_short": "руб",
"excise_short": "0102900254680370215_Re/=lSbNiGD",
"barcode": 2038893425820,
"nm_id": 169085355,
"operation_type_id": 1,
"fiscal_doc_number": 12345678,
"fiscal_dt": "2024-01-01",
"fiscal_drive_number": "string",
"rid": 606217433440,
"srid": "7513432034713632943.1.0"
}
]
}
}

Платное хранение

Чтобы получить отчёт:

Создайте его с помощью метода Создать отчёт.
Дождитесь, когда отчёт будет готов. Готовность можно узнать с помощью метода Проверить статус. Готовый отчёт хранится 2 часа, после его нельзя будет получить.
Загрузите отчёт с помощью метода Получить отчёт.

Создать отчёт

Создаёт задание на генерацию отчёта. Можно получить отчёт максимум за 8 дней. Максимум 1 запрос в минуту

Authorizations:

HeaderApiKey

query Parameters

dateFrom required	string Example: dateFrom=2022-01-01 Начало отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры: `2019-06-20` `2019-06-20T23:59:59` `2019-06-20T00:00:00.12345` `2017-03-25T00:00:00`
dateTo required	string Example: dateTo=2022-01-09 Конец отчётного периода в формате RFC3339. Можно передать дату или дату со временем. Примеры: `2019-06-20` `2019-06-20T23:59:59` `2019-06-20T00:00:00.12345` `2017-03-25T00:00:00`

Responses

Response Schema: application/json

object (CreateTaskResponseData)

Response samples

200
400

Content type

application/json

{"data": {"taskId": "219eaecf-e532-4bd8-9f15-8036ec1b042d"
}
}

Проверить статус

Возвращает статус задания на генерацию. Максимум 1 запрос в минуту

Authorizations:

HeaderApiKey

path Parameters

task_id

required

string

Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response Schema: application/json

object (GetTasksResponseData)

Response samples

200
400

Content type

application/json

{"data": {"id": "cad56ec5-91ec-43a2-b5e8-efcf244cf309",
"status": "done"
}
}

Получить отчёт

Возвращает отчёт по ID задания. Максимум 1 запрос в минуту

Authorizations:

HeaderApiKey

path Parameters

task_id

required

string

Example: 06e06887-9d9f-491f-b16a-bb1766fcb8d2

ID задания на генерацию

Responses

Response Schema: application/json

Array

date	string Дата, за которую был расчёт или перерасчёт
logWarehouseCoef	number Коэффициент логистики и хранения
officeId	integer ID склада
warehouse	string Название склада
warehouseCoef	number Коэффициент склада
giId	integer ID поставки
chrtId	integer Идентификатор размера для этого артикула Wildberries
size	string Размер (`techSize` в карточке товара)
barcode	string Баркод
subject	string Предмет
brand	string Бренд
vendorCode	string Артикул продавца
nmId	integer Артикул Wildberries
volume	number Объём товара
calcType	string Способ расчёта
warehousePrice	number Сумма хранения
barcodesCount	integer Количество единиц товара (штук), подлежащих тарифицированию за расчётные сутки
palletPlaceCode	integer Код палетоместа
palletCount	number Количество палет
originalDate	string Если был перерасчёт, это дата первоначального расчёта. Если перерасчёта не было, совпадает с `date`
loyaltyDiscount	number Скидка программы лояльности, ₽

Response samples

200
400

Content type

application/json

[{"date": "2023-10-01",
"logWarehouseCoef:": 1,
"officeId": 507,
"warehouse": "Коледино",
"warehouseCoef": 1.7,
"giId": 123456,
"chrtId": 1234567,
"size": "0",
"barcode": "",
"subject": "Маски одноразовые",
"brand": "1000 Каталог",
"vendorCode": "567383",
"nmId": 1234567,
"volume": 12,
"calcType": "короба: без габаритов",
"warehousePrice": 7.65,
"barcodesCount": 1,
"palletPlaceCode": 0,
"palletCount": 0,
"originalDate": "2023-03-01"
}
]

Платная приёмка

Получить отчёт

Возвращает даты и стоимость приёмки. Можно получить отчёт максимум за 31 день.

Максимум 1 запрос в минуту

Authorizations:

HeaderApiKey

query Parameters

dateFrom required	string Example: dateFrom=2023-12-01 Начало отчётного периода, `ГГГГ-ММ-ДД`
dateTo required	string Example: dateTo=2023-12-15 Конец отчётного периода, `ГГГГ-ММ-ДД`

Responses

Response Schema: application/json

Array of objects

Response samples

200
400
500

Content type

application/json

{"report": [{"count": 40,
"giCreateDate": "2023-08-23",
"incomeId": 11834106,
"nmID": 123456789,
"shkСreateDate": "2023-04-10",
"subjectName": "Добавки пищевые",
"sum": 200
}
]
}

Отчёты по удержаниям

Самовыкупы

Возвращает отчёт по удержаниям за самовыкупы. Отчёт формируется каждую неделю по средам, до 7:00 по московскому времени, и содержит данные за одну неделю. Также можно получить отчёт за всё время с августа 2023.

Удержание за самовыкуп — это 30% от стоимости товаров. Минимальная сумма всех удержаний — 100 000 ₽, если за неделю в ПВЗ привезли больше ваших товаров, чем на 100 000 ₽.

Максимум 10 запросов за 100 минут.

Authorizations:

HeaderApiKey

query Parameters

date	string Example: date=2023-12-01 Дата, которая входит в отчётный период, `ГГГГ-ММ-ДД`. Чтобы получить данные за всё время с августа 2023, не указывайте этот параметр

Responses

Response Schema: application/json

Array of objects

Response samples

200
400

Content type

application/json

{"details": [{"nmID": 123456789,
"sum": 3540,
"currency": "RUB",
"dateFrom": "2023-08-23",
"dateTo": "2023-08-29"
}
]
}

Подмена товара

Возвращает отчёт об удержаниях за отправку не тех товаров, пустых коробок или коробок без товара, но с посторонними предметами. В таких случаях удерживается 100% от стоимости заказа.

Можно получить отчёт максимум за 31 день, доступны данные с июня 2023.

Максимум 1 запрос в минуту.

Authorizations:

HeaderApiKey

query Parameters

dateFrom required	string Example: dateFrom=2023-12-01 Начало отчётного периода, `ГГГГ-ММ-ДД`
dateTo required	string Example: dateTo=2023-12-15 Конец отчётного периода, `ГГГГ-ММ-ДД`

Responses

Response Schema: application/json

Array of objects

Response samples

200
400

Content type

application/json

{"report": [{"amount": 24514.5,
"date": "2023-12-15",
"lostReason": "Подмена. Вместо большой железной дороги поступила маленькая коробка.",
"nmID": 123456789,
"photoUrl": "https://mstatic.wbstatic.net/writeoff_to_the_seller/12345678911-2023-06-21T12:13:37.768Z-1.png",
"shkID": 14555724540
}
]
}

Коэффициент логистики и хранения

Возвращает коэффициенты логистики и хранения. Они рассчитываются на неделю (с понедельника по воскресенье).

Можно получить данные с 31.10.2022.

Максимум 1 запрос в минуту.

Как это работает

В начале каждой недели для продавца рассчитывается новый коэффициент логистики и хранения. Затем стоимость логистики и хранения умножается на коэффициент этой недели.

Как считается коэффициент

На основе расхождения фактических и заявленных габаритов упаковки товара:

Измеряем товары.
Работники склада измеряют по одному товару каждого наименования, с учётом упаковки (кроме товаров меньше 2 л). Для расчёта используются измерения за 30 дней до начала текущей недели.
Считаем коэффициент для товара.
Результаты измерений сравниваются с габаритами из карточки товара. В зависимости от разницы каждому наименованию присваивается коэффициент по товару.
Считаем коэффициент логистики и хранения.
Коэффициент логистики и хранения — это средний коэффициент по товарам.

Коэффициент логистики и хранения равен 1, если

По товарам продавца сделано меньше 10 уникальных измерений.
Средняя разница в габаритах не больше 10%.

Для продавцов с коэффициентом 1 стоимость логистики и хранения не увеличится.

Authorizations:

HeaderApiKey

query Parameters

date	string Example: date=2023-12-01 Дата, которая входит в отчётный период, `ГГГГ-ММ-ДД`

Responses

Response Schema: application/json

Array of objects

Response samples

200
400
500

Content type

application/json

{"report": [{"actualHeight": 6,
"actualLength": 39,
"actualVolume": 7.02,
"actualWidth": 30,
"date": "2023-04-11T12:21:19Z",
"dimensionDifference": 101.74,
"height": 10,
"length": 30,
"logWarehouseCoef": 1,
"nmID": 123456789,
"photoUrls": ["https://photos.wbstatic.net/handheld-goods-measurements-photo/123456789_73984211-e6c3-44e2-66af-0d44d2620308.jpg",
"https://photos.wbstatic.net/handheld-goods-measurements-photo/123456789_8ee5ff5e-c6bb-426c-7d12-c2dd228c0f62.jpg"
],
"title": "Сухой корм для крупных собак ассорти мясное, 10 кг",
"volume": 6.9,
"width": 23
}
]
}

Маркировка товара

Возвращает отчёт о штрафах за отсутствие обязательной маркировки товаров.
В отчёте представлены фотографии товаров, на которых маркировка отсутствует либо не считывается.
Можно получить данные максимум за 31 день, начиная с марта 2024.
Максимум 10 запросов за 10 минут

Authorizations:

HeaderApiKey

query Parameters

dateFrom required	string <date> Example: dateFrom=2024-04-01 Начало отчётного периода, `ГГГГ-ММ-ДД`
dateTo required	string <date> Example: dateTo=2024-04-30 Конец отчётного периода, `ГГГГ-ММ-ДД`

Responses

Response Schema: application/json

Array of objects

Response samples

200
400

Content type

application/json

{"report": [{"amount": 1500,
"date": "2024-03-26T01:00:00Z",
"incomeId": 18484008,
"nmID": 49434732,
"photoUrls": ["https://static-basket-03.wb.ru/vol54/photo-fixation-violation-shk-excise/12345678900-1811460999-1.jpg",
"https://static-basket-03.wb.ru/vol54/photo-fixation-violation-shk-excise/12345678900-1811461000-2.jpg",
"https://static-basket-03.wb.ru/vol54/photo-fixation-violation-shk-excise/12345678900-1811461001-3.jpg"
],
"shkID": 17346434621,
"sku": "4630153500834"
}
]
}

Описание API Аналитика

Воронка продаж

Получение статистики КТ за выбранный период, по nmID/предметам/брендам/тегам

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Получение статистики КТ за период, сгруппированный по предметам, брендам и тегам

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Получение статистики КТ по дням по выбранным nmID

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Получение статистики КТ по дням за период, сгруппированный по предметам, брендам и тегам

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Воронка продаж (Джем)

Создать отчёт

Authorizations:

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Получить список отчётов

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Сгенерировать отчёт повторно

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Получить отчёт

Authorizations:

path Parameters

Responses

Response Schema: text/csv

Response samples

Товары с обязательной маркировкой

Отчёт по товарам с обязательной маркировкой

Authorizations:

query Parameters

Request Body schema: application/jsonoptional

Responses

Response Schema: application/json

Request samples

Response samples

Платное хранение

Создать отчёт

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Проверить статус

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Получить отчёт

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
optional