API docs by Redocly

Statistics

Methods to get different reports. For Paid storage report, send a request to generate it, and then a request to get it. other report are available immediately, without pre-generation.

Statistics

Supplies

Supplies. Maximum 1 request per minute

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Date and time of last change on the supplie.
Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

  • `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

Supply number

number
string <= 40 characters

Universal transfer document number

date
string <date>

Receipt date. If the time zone is not specified, then Moscow time UTC+3 is taken.

lastChangeDate
string <date-time>

Date and time of refreshing info of service. This field corresponds to the dateFrom parameter in the request. If the time zone is not specified, then Moscow time UTC+3 is taken.

supplierArticle
string <= 75 characters

Supplier article

techSize
string <= 30 characters

Product size (eg S, M, L, XL, 42, 42-43)

barcode
string <= 30 characters

Barcode

quantity
integer

Quantity

totalPrice
number

Total price

dateClose
string <date>

Date of closing in WB. If the time zone is not specified, then Moscow time UTC+3 is taken.

warehouseName
string <= 50 characters

Name of warehouse

nmId
integer

WB article

status
string <= 50 characters
Value: "Accepted"

Current supply status

Response samples

Content type
application/json
[
  • {
    }
]

Warehouse

WB stock product leftover. The data is updated every 30 minutes. The statistics service does not keep a history of product leftovers, so you can only retrieve data about them in 'real time' mode.

Maximum 1 request per minute

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Date and time of last change on the product.
The earliest possible value should be entered to get the total leftover, e.g. 2019-06-20. Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

  • `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>

Date and time of refreshing info of service. This field corresponds to the dateFrom parameter in the request. If the time zone is not specified, then Moscow time UTC+3 is taken.

warehouseName
string <= 50 characters

Name of warehouse

supplierArticle
string <= 75 characters

Supplier article

nmId
integer

WB article

barcode
string <= 30 characters

Barcode

quantity
integer

Quantity available for sale (how many can be added to cart)

inWayToClient
integer

On the way to the customer

inWayFromClient
integer

On the way from the client

quantityFull
integer

Total (unsold) quantity that is in stock (= quantity + in transit)

category
string <= 50 characters

Category

subject
string <= 50 characters

Subject

brand
string <= 50 characters

Brand

techSize
string <= 30 characters

Product size (eg S, M, L, XL, 42, 42-43)

Price
number

Price

Discount
number

Discount

isSupply
boolean

Supply contract (internal process data)

isRealization
boolean

Implementation contract (internal process data)

SCCode
string <= 50 characters

Contract code (internal process data)

Response samples

Content type
application/json
[
  • {
    }
]

Orders

Orders.
Important: storage of data for orders is guaranteed for no more than 90 days from the date of order. The data is updated every 30 minutes. The exact time when information was updated in the service can be seen in the lastChangeDate field.
To identify goods from one order, as well as sales on them, you should use the gNumber field (lines with the same value of this field refer to one order) and the number of the unique item in the order, the odid (rid) field.

Maximum 1 request per minute

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Date and time of last change on the order.
Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

  • `2019-06-20`
  • `2019-06-20T23:59:59`
  • `2019-06-20T00:00:00.12345`
  • `2017-03-25T00:00:00`
flag
integer
Default: 0

If parameter flag=0 (or it doesn't exist in requests string), then call of API methods returns data, which value of field lastChangeDate (date and time of refreshing info of service) is greater or equal to the given parameter value dateFrom. In this case the number of returned rows of data varies from 0 to approximately 100,000.
If parameter flag=1, then information about all orders or sales with the date will be uploaded, that equals to the passed parameter dateFrom (in this case the time in the date doesn't matter). Also the number of returned rows of data will be equal to the number of all orders or sales that were made on the specified date, passed in the dateFrom parameter.

Responses

Response Schema: application/json
Array
gNumber
string <= 50 characters

Order number. Combines all items of one order.

date
string <date-time>

Date and time of order. This field equals to dateFrom in request if flag=1. If the time zone is not specified, then Moscow time UTC+3 is taken.

lastChangeDate
string <date-time>

Date and time of refreshing info of service. This field corresponds to the dateFrom parameter in the request if the flag=0 parameter exist or not specified. If the time zone is not specified, then Moscow time UTC+3 is taken.

supplierArticle
string <= 75 characters

Supplier article

techSize
string <= 30 characters

Product size (eg S, M, L, XL, 42, 42-43)

barcode
string <= 30 characters

Barcode

totalPrice
number

Agreed price without discounts. You should use priceWithDiscount = totalPrice * (1 - discountPercent/100) formula for get price with discount.

discountPercent
integer

Agreed final discount. If you apply this parameter to the totalPrice, it will give the amount to be paid.

warehouseName
string <= 50 characters

Shipping warehouse name

oblast
string <= 200 characters

Area

incomeID
integer

Supply number (from seller to warehouse)

odid
integer

Unique ID for order position. That parameter may use for find matches between orders and sales.

nmId
integer

WB article

subject
string <= 50 characters

Subject

category
string <= 50 characters

Category

brand
string <= 50 characters

Brand

isCancel
boolean

Order canceling. true - order was canceled before payment.

cancel_dt
string <date-time>

Date and time for order canceling. If order wasn't canceled, then "0001-01-01T00:00:00". If the time zone is not specified, then Moscow time UTC+3 is taken.

sticker
string

The digital value of the sticker that is attached to the product during the order assembly process using the Marketplace system.

srid
string

Unique order ID.
Note for those working with Marketplace API: srid equals rid in response of orders methods

orderType
string

Order type:

  • Клиентский - an order received from a customer
  • Возврат Брака - return the item to the seller
  • Принудительный возврат - return the goods to the seller
  • Возврат обезлички - return the item to the seller
  • Возврат Неверного Вложения - return the item to the seller
  • Возврат Продавца - return the goods to the seller

Response samples

Content type
application/json
[
  • {
    }
]

Sales

Sales and returns.
Data storage is guaranteed for no more than 90 days from the date of sale.
The data updated every 30 minutes.
The srid field should be used to identify the order.
1 line means 1 sale/return and means 1 item.
Maximum 1 request per minute

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Date and time of last change on the sale/return.
Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

  • `2019-06-20`
  • `2019-06-20T23:59:59`
  • `2019-06-20T00:00:00.12345`
  • `2017-03-25T00:00:00`
flag
integer
Default: 0

If parameter flag=0 (or it doesn't exist in requests string), then call of API methods returns data, which value of field lastChangeDate (date and time of refreshing info of service) is greater or equal to the given parameter value dateFrom. In this case the number of returned rows of data varies from 0 to approximately 100,000.
If parameter flag=1, then information about all orders or sales with the date will be uploaded, that equals to the passed parameter dateFrom (in this case the time in the date doesn't matter). Also the number of returned rows of data will be equal to the number of all orders or sales that were made on the specified date, passed in the dateFrom parameter.

Responses

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

Date and time of sale. This field equals to dateFrom in request if flag=1. If the time zone is not specified, then Moscow time (UTC+3) is taken

lastChangeDate
string <date-time>

Date and time of refreshing info of service. This field corresponds to the dateFrom parameter in the request if the flag=0 parameter exist or not specified. If the time zone is not specified, then Moscow time (UTC+3) is taken

warehouseName
string <= 50 characters

Shipping warehouse

countryName
string <= 200 characters

Country

oblastOkrugName
string <= 200 characters

Area

regionName
string <= 200 characters

Region

supplierArticle
string <= 75 characters

Supplier article

nmId
integer

WB article

barcode
string <= 30 characters

Barcode

category
string <= 50 characters

Category

subject
string <= 50 characters

Subject

brand
string <= 50 characters

Brand

techSize
string <= 30 characters

Product size

incomeID
integer

Supply number

isSupply
boolean

Supply contract

isRealization
boolean

Implementation contract

totalPrice
number

Price without discounts

discountPercent
integer

Seller's discount

spp
number

WB discount

paymentSaleAmount
integer

Paid from WB Wallet

forPay
number

To transfer to the supplier

finishedPrice
number

Price with all discounts, except WB Wallet sum

priceWithDisc
number

Price with seller's discount, from which the amount to be transferred to the seller is calculated according to the following formula forPay (= totalPrice * (1 - discountPercent/100))

saleID
string <= 15 characters

The unique ID of the sale/refund.

  • `SXXXXXXXXXX` — sale
  • `RXXXXXXXXXX` — refund
orderType
string

Order type

  • `Клиентский` - an order received from a customer
  • `Возврат Брака` - return the item to the seller
  • `Принудительный возврат` - return the goods to the seller
  • `Возврат обезлички` - return the item to the seller
  • `Возврат Неверного Вложения` - return the item to the seller
  • `Возврат Продавца` - return the goods to the seller
sticker
string

sticker ID

gNumber
string <= 50 characters

Order number

odid
integer

The unique ID of the order item

srid
string

Unique order ID.
Note for those working with Marketplace API: srid equals rid in response of orders methods

Response samples

Content type
application/json
[
  • {
    }
]

Realization sales report

Details to the weekly realization report. The report contains data for the last 3 months. Maximum 1 request per minute

To get the data before 29 January, use URL with v1: https://statistics-api.wildberries.ru/api/v1/supplier/reportDetailByPeriod

If there is no data for the specified period, the method will return null.

Technical break in the work of the method: every Monday from 3:00 AM to 4:00 PM.
Manual: Save statistics by Excel

Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Starting date of the report.
Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

  • `2019-06-20`
  • `2019-06-20T23:59:59`
  • `2019-06-20T00:00:00.12345`
  • `2017-03-25T00:00:00`
limit
integer
Default: 100000

The maximum number of report rows returned by the method. Cannot be more than 100000.

dateTo
required
string <date>

Report end date

rrdid
integer

The unique ID of the report line. Required to receive the report in parts.
Report loading must start with rrdid = 0 and on subsequent API calls, pass the rrd_id value in the request from the row line received as a result of the previous call.
Thus, to load a single report, you may need to call the API until the number of rows returned is zero.

Responses

Response Schema: application/json
Array
realizationreport_id
integer

Report number

date_from
string <date-time>

Start date of the reporting period

date_to
string <date-time>

End date of the reporting period

create_dt
string <date-time>

Report generation date

currency_name
string

Currency of report

suppliercontract_code
object

Contract

rrd_id
integer

Row number

gi_id
integer

Supply number

subject_name
string

Subject

nm_id
integer

WB article

brand_name
string

Brand

sa_name
string

Seller's article

ts_name
string

Size

barcode
string

Barcode

doc_type_name
string

Document type

quantity
integer

Quantity

retail_price
number

Retail price

retail_amount
number

Sales amount (refunds)

sale_percent
integer

Agreed discount

commission_percent
number

Commission percentage

office_name
string

Warehouse

supplier_oper_name
string

Reason for payment

order_dt
string <date-time>

Date of order.
Sent with an explicit indication of the time zone

sale_dt
string <date-time>

Dte of sale.
Sent with an explicit indication of the time zone

rr_dt
string <date-time>

Date of operation.
Sent with an explicit indication of the time zone

shk_id
integer

Barcode

retail_price_withdisc_rub
number

Retail price with agreed discount

delivery_amount
integer

Delivery amount

return_amount
integer

Return amount

delivery_rub
number

Logistics cost

gi_box_type_name
string

Box type

product_discount_for_report
number

Agreed discount

supplier_promo
number

Promo code

rid
integer

Unique order ID

ppvz_spp_prc
number

Discount of regular customer

ppvz_kvw_prc_base
number

RCW - Reward coefficient of Wildberries, Amount of RCW without VAT, % basic

ppvz_kvw_prc
number

RCW - Reward coefficient of Wildberries, Total RCW without VAT, %

sup_rating_prc_up
number

Size of RCW reduction due to rating

is_kgvp_v2
number

Size of RCW reduction due to promotion

ppvz_sales_commission
number

Sales commission before deducting attorney's services, without VAT

ppvz_for_pay
number

To the transfer to the seller for the sold products

ppvz_reward
number

Refund for the issuance and return of products to the point of issue of orders

acquiring_fee
number

Acquiring costs compensation.
WB costs for acquiring services: deducted from WB remuneration and does not affect seller's income.

acquiring_bank
string

Name of the acquiring bank

ppvz_vw
number

WB remuneration without VAT

ppvz_vw_nds
number

VAT from WB remuneration

ppvz_office_id
integer

Office number

ppvz_office_name
string

Delivery office name

ppvz_supplier_id
integer

Partner number

ppvz_supplier_name
string

Partner

ppvz_inn
string

Partner's individual tax number

declaration_number
string

Number of customs declaration

bonus_type_name
string

Justification of fines and surcharges.
The field will be in the response if a value exists

sticker_id
string

The digital value of the sticker that is attached to the product during the order assembly process using the Marketplace system.

site_country
string

Country of sale

penalty
number

Fines

additional_payment
number

Surcharges

rebill_logistic_cost
number

Compensation of transportation costs The field will be in the response if there is a value.

rebill_logistic_org
string

Organizer of transportation The field will be in the response if there is a value

kiz
string

Marking code.
The field will be in the response if value exists

storage_fee
number

Storage cost

deduction
number

Other payments/deductions

acceptance
number

Receiving cost

srid
string

The unique identifier for the order. Note for those using the Marketplace API: srid is equal to rid in assembly tasks methods responses

report_type
integer

Report type:

  • 1 — standard
  • 2 — purchase notification

Response samples

Content type
application/json
[
  • {
    }
]