API docs by Redocly

Описание API Статистики

С помощью этих методов можно получить отчёты.

Статистика

Поставки

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

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по поставке.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Мск (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

Responses

Response Schema: application/json
Array
incomeId
integer

Номер поставки

number
string <= 40 characters

Номер УПД

date
string <date>

Дата поступления. Если часовой пояс не указан, то берется Московское время UTC+3.

lastChangeDate
string <date-time>

Дата и время обновления информации в сервисе. Это поле соответствует параметру dateFrom в запросе. Если часовой пояс не указан, то берется Московское время UTC+3.

supplierArticle
string <= 75 characters

Артикул продавца

techSize
string <= 30 characters

Размер товара (пример S, M, L, XL, 42, 42-43)

barcode
string <= 30 characters

Бар-код

quantity
integer

Количество

totalPrice
number

Цена из УПД

dateClose
string <date>

Дата принятия (закрытия) в WB. Если часовой пояс не указан, то берется Московское время UTC+3

warehouseName
string <= 50 characters

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

nmId
integer

Артикул WB

status
string <= 50 characters
Value: "Принято"

Текущий статус поставки

Response samples

Content type
application/json
[
  • {
    }
]

Склад

Остатки товаров на складах WB. Данные обновляются раз в 30 минут.
Сервис статистики не хранит историю остатков товаров, поэтому получить данные о них можно только в режиме "на текущий момент".
Максимум 1 запрос в минуту

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по товару.
Для получения полного остатка следует указывать максимально раннее значение.
Например, 2019-06-20
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Мск (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

Responses

Response Schema: application/json
Array
lastChangeDate
string <date-time>

Дата и время обновления информации в сервисе. Это поле соответствует параметру dateFrom в запросе. Если часовой пояс не указан, то берется Московское время (UTC+3)

warehouseName
string <= 50 characters

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

supplierArticle
string <= 75 characters

Артикул продавца

nmId
integer

Артикул WB

barcode
string <= 30 characters

Баркод

quantity
integer

Количество, доступное для продажи (сколько можно добавить в корзину)

inWayToClient
integer

В пути к клиенту

inWayFromClient
integer

В пути от клиента

quantityFull
integer

Полное (непроданное) количество, которое числится за складом (= quantity + в пути)

category
string <= 50 characters

Категория

subject
string <= 50 characters

Предмет

brand
string <= 50 characters

Бренд

techSize
string <= 30 characters

Размер

Price
number

Цена

Discount
number

Скидка

isSupply
boolean

Договор поставки (внутренние технологические данные)

isRealization
boolean

Договор реализации (внутренние технологические данные)

SCCode
string <= 50 characters

Код контракта (внутренние технологические данные)

Response samples

Content type
application/json
[
  • {
    }
]

Заказы

Заказы.
Гарантируется хранение данных не более 90 дней от даты заказа.
Данные обновляются раз в 30 минут.
Для идентификации заказа следует использовать поле srid.
1 строка = 1 заказ = 1 единица товара.
Максимум 1 запрос в минуту

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по заказу.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Мск (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

flag
integer
Default: 0

Если параметр flag=0 (или не указан в строке запроса), при вызове API возвращаются данные, у которых значение поля lastChangeDate (дата время обновления информации в сервисе) больше или равно переданному значению параметра dateFrom. При этом количество возвращенных строк данных варьируется в интервале от 0 до примерно 100 000.
Если параметр flag=1, то будет выгружена информация обо всех заказах или продажах с датой, равной переданному параметру dateFrom (в данном случае время в дате значения не имеет). При этом количество возвращенных строк данных будет равно количеству всех заказов или продаж, сделанных в указанную дату, переданную в параметре dateFrom.

Responses

Response Schema: application/json
Array
date
string <date-time>

Дата и время заказа. Это поле соответствует параметру dateFrom в запросе, если параметр flag=1. Если часовой пояс не указан, то берется Московское время (UTC+3).

lastChangeDate
string <date-time>

Дата и время обновления информации в сервисе. Это поле соответствует параметру dateFrom в запросе, если параметр flag=0 или не указан. Если часовой пояс не указан, то берется Московское время (UTC+3).

warehouseName
string <= 50 characters

Склад отгрузки

countryName
string <= 200 characters

Страна

oblastOkrugName
string <= 200 characters

Округ

regionName
string <= 200 characters

Регион

supplierArticle
string <= 75 characters

Артикул продавца

nmId
integer

Артикул WB

barcode
string <= 30 characters

Баркод

category
string <= 50 characters

Категория

subject
string <= 50 characters

Предмет

brand
string <= 50 characters

Бренд

techSize
string <= 30 characters

Размер товара

incomeID
integer

Номер поставки

isSupply
boolean

Договор поставки

isRealization
boolean

Договор реализации

totalPrice
number

Цена без скидок

discountPercent
integer

Скидка продавца

spp
number

Скидка WB

finishedPrice
number

Цена с учетом всех скидок, кроме суммы по WB Кошельку

priceWithDisc
number

Цена со скидкой продавца (= totalPrice * (1 - discountPercent/100))

isCancel
boolean

Отмена заказа. true - заказ отменен

cancelDate
string <date-time>

Дата и время отмены заказа. Если заказ не был отменен, то "0001-01-01T00:00:00".Если часовой пояс не указан, то берется Московское время UTC+3.

orderType
string

Тип заказа:

  • Клиентский — заказ, поступивший от покупателя
  • Возврат Брака — возврат товара продавцу
  • Принудительный возврат — возврат товара продавцу
  • Возврат обезлички — возврат товара продавцу
  • Возврат Неверного Вложения — возврат товара продавцу
  • Возврат Продавца — возврат товара продавцу
  • Возврат из Отзыва — возврат товара продавцу
  • АвтоВозврат МП — возврат товара продавцу
  • Недокомплект (Вина продавца) — возврат товара продавцу
  • Возврат КГТ — возврат товара продавцу
sticker
string

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

gNumber
string <= 50 characters

Номер заказа

srid
string

Уникальный идентификатор заказа.
Примечание для использующих API Маркетплейс: srid равен rid в ответах методов сборочных заданий.

Response samples

Content type
application/json
[
  • {
    }
]

Продажи

Продажи и возвраты.
Гарантируется хранение данных не более 90 дней от даты продажи.
Данные обновляются раз в 30 минут.
Для идентификации заказа следует использовать поле srid.
1 строка = 1 продажа/возврат = 1 единица товара.
Максимум 1 запрос в минуту

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Дата и время последнего изменения по продаже/возврату.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Мск (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

flag
integer
Default: 0

Если параметр flag=0 (или не указан в строке запроса), при вызове API возвращаются данные, у которых значение поля lastChangeDate (дата время обновления информации в сервисе) больше или равно переданному значению параметра dateFrom. При этом количество возвращенных строк данных варьируется в интервале от 0 до примерно 100 000.
Если параметр flag=1, то будет выгружена информация обо всех заказах или продажах с датой, равной переданному параметру dateFrom (в данном случае время в дате значения не имеет). При этом количество возвращенных строк данных будет равно количеству всех заказов или продаж, сделанных в указанную дату, переданную в параметре dateFrom.

Responses

Response Schema: application/json
Array
date
string <date-time>

Дата и время продажи. Это поле соответствует параметру dateFrom в запросе, если параметр flag=1. Если часовой пояс не указан, то берется Московское время (UTC+3).

lastChangeDate
string <date-time>

Дата и время обновления информации в сервисе. Это поле соответствует параметру dateFrom в запросе, если параметр flag=0 или не указан. Если часовой пояс не указан, то берется Московское время (UTC+3).

warehouseName
string <= 50 characters

Склад отгрузки

countryName
string <= 200 characters

Страна

oblastOkrugName
string <= 200 characters

Округ

regionName
string <= 200 characters

Регион

supplierArticle
string <= 75 characters

Артикул продавца

nmId
integer

Артикул WB

barcode
string <= 30 characters

Баркод

category
string <= 50 characters

Категория

subject
string <= 50 characters

Предмет

brand
string <= 50 characters

Бренд

techSize
string <= 30 characters

Размер товара

incomeID
integer

Номер поставки

isSupply
boolean

Договор поставки

isRealization
boolean

Договор реализации

totalPrice
number

Цена без скидок

discountPercent
integer

Скидка продавца

spp
number

Скидка WB

paymentSaleAmount
integer

Оплачено с WB Кошелька

forPay
number

К перечислению продавцу

finishedPrice
number

Фактическая цена с учетом всех скидок (к взиманию с покупателя)

priceWithDisc
number

Цена со скидкой продавца, от которой считается сумма к перечислению продавцу forPay (= totalPrice * (1 - discountPercent/100))

saleID
string <= 15 characters

Уникальный идентификатор продажи/возврата

  • S********** — продажа
  • R********** — возврат (на склад WB)

orderType
string

Тип заказа:

  • Клиентский — заказ, поступивший от покупателя
  • Возврат Брака — возврат товара продавцу
  • Принудительный возврат — возврат товара продавцу
  • Возврат обезлички — возврат товара продавцу
  • Возврат Неверного Вложения — возврат товара продавцу
  • Возврат Продавца — возврат товара продавцу
  • Возврат из Отзыва — возврат товара продавцу
  • АвтоВозврат МП — возврат товара продавцу
  • Недокомплект (Вина продавца) — возврат товара продавцу
  • Возврат КГТ — возврат товара продавцу
sticker
string

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

gNumber
string <= 50 characters

Номер заказа

srid
string

Уникальный идентификатор заказа.
Примечание для использующих API Маркетплейс: srid равен rid в ответах методов сборочных заданий.

Response samples

Content type
application/json
[
  • {
    }
]

Отчет о продажах по реализации

Детализация к еженедельному отчёту реализации. Доступны данные, начиная с 29 января 2024 года. Максимум 1 запрос в минуту.

Если нет данных за указанный период, метод вернет [].

Инструкция: Сохранение статистики в Excel

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Начальная дата отчета.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Мск (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

limit
integer
Default: 100000

Максимальное количество строк отчета, возвращаемых методом. Не может быть более 100000.

dateTo
required
string <date>

Конечная дата отчета

rrdid
integer

Уникальный идентификатор строки отчета. Необходим для получения отчета частями.
Загрузку отчета нужно начинать с rrdid = 0 и при последующих вызовах API передавать в запросе значение rrd_id из последней строки, полученной в результате предыдущего вызова.
Таким образом для загрузки одного отчета может понадобиться вызывать API до тех пор, пока количество возвращаемых строк не станет равным нулю.

Responses

Response Schema: application/json
Array
realizationreport_id
integer

Номер отчёта

date_from
string <date>

Дата начала отчётного периода

date_to
string <date>

Дата конца отчётного периода

create_dt
string <date>

Дата формирования отчёта

currency_name
string

Валюта отчёта

suppliercontract_code
object

Договор

rrd_id
integer

Номер строки

gi_id
integer

Номер поставки

subject_name
string

Предмет

nm_id
integer

Артикул WB

brand_name
string

Бренд

sa_name
string

Артикул продавца

ts_name
string

Размер

barcode
string

Баркод

doc_type_name
string

Тип документа

quantity
integer

Количество

retail_price
number

Цена розничная

retail_amount
number

Сумма продаж (возвратов)

sale_percent
integer

Согласованная скидка

commission_percent
number

Процент комиссии

office_name
string

Склад

supplier_oper_name
string

Обоснование для оплаты

order_dt
string <date-time>

Дата заказа.
Присылается с явным указанием часового пояса

sale_dt
string <date-time>

Дата продажи.
Присылается с явным указанием часового пояса

rr_dt
string <date>

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

shk_id
integer

Штрих-код

retail_price_withdisc_rub
number

Цена розничная с учетом согласованной скидки

delivery_amount
integer

Количество доставок

return_amount
integer

Количество возвратов

delivery_rub
number

Стоимость логистики

gi_box_type_name
string

Тип коробов

product_discount_for_report
number

Согласованный продуктовый дисконт

supplier_promo
number

Промокод

rid
integer

Уникальный идентификатор заказа

ppvz_spp_prc
number

Скидка постоянного покупателя

ppvz_kvw_prc_base
number

Размер кВВ без НДС, % базовый

ppvz_kvw_prc
number

Итоговый кВВ без НДС, %

sup_rating_prc_up
number

Размер снижения кВВ из-за рейтинга

is_kgvp_v2
number

Размер снижения кВВ из-за акции

ppvz_sales_commission
number

Вознаграждение с продаж до вычета услуг поверенного, без НДС

ppvz_for_pay
number

К перечислению продавцу за реализованный товар

ppvz_reward
number

Возмещение за выдачу и возврат товаров на ПВЗ

acquiring_fee
number

Возмещение издержек по эквайрингу.
Издержки WB за услуги эквайринга: вычитаются из вознаграждения WB и не влияют на доход продавца.

acquiring_percent
number

Размер комиссии за эквайринг без НДС, %

acquiring_bank
string

Наименование банка-эквайера

ppvz_vw
number

Вознаграждение WB без НДС

ppvz_vw_nds
number

НДС с вознаграждения WB

ppvz_office_id
integer

Номер офиса

ppvz_office_name
string

Наименование офиса доставки

ppvz_supplier_id
integer

Номер партнера

ppvz_supplier_name
string

Партнер

ppvz_inn
string

ИНН партнера

declaration_number
string

Номер таможенной декларации

bonus_type_name
string

Обоснование штрафов и доплат.
Поле будет в ответе при наличии значения

sticker_id
string

Цифровое значение стикера, который клеится на товар в процессе сборки заказа по схеме "Маркетплейс"

site_country
string

Страна продажи

penalty
number

Штрафы

additional_payment
number

Доплаты

rebill_logistic_cost
number

Возмещение издержек по перевозке. Поле будет в ответе при наличии значения

rebill_logistic_org
string

Организатор перевозки. Поле будет в ответе при наличии значения

kiz
string

Код маркировки.
Поле будет в ответе при наличии значения

storage_fee
number

Стоимость хранения

deduction
number

Прочие удержания/выплаты

acceptance
number

Стоимость платной приёмки

srid
string

Уникальный идентификатор заказа.

Примечание для использующих API Marketplace: srid равен rid в ответах методов сборочных заданий.

report_type
integer

Тип отчёта:

  • 1 — стандартный
  • 2 — для уведомления о выкупе

Response samples

Content type
application/json
[
  • {
    }
]