API docs by Redocly

Seller API Marketplace

Orders

Get new orders

Returns a list of all new orders.

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array of objects (OrderNew)

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Get orders

Returns orders information without current status.
It is possible to export data for a specific period, maximum 30 calendar days

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Pagination parameter. Sets the limit for the amount of data returned.

next
required
integer <int64>

Pagination parameter. Sets the value from which to retrieve the next batch. It should start at 0 to get the full list of data. For the subsequent requests, you must take the value from the next field in the response.

dateFrom
integer

Period start date in Unix timestamp format. By default date is 30 days before the request

dateTo
integer

Period end date in Unix timestamp format

Responses

Response Schema: application/json
next
integer <int64> (Next)

Pagination parameter. Sets the value from which to retrieve the next batch

Array of objects (Order)

Response samples

Content type
application/json
{
  • "next": 13833711,
  • "orders": [
    ]
}

Get orders statuses

Returns the statuses of orders from the request.

supplierStatus is a status of an order. Its change is always triggered only by the supplier.
Possible values for this field are:

Status Description How to move an order to this status
new New order
confirm Order on assembly Moved automatically when the order is added to the supply PATCH /api/v3/supplies/{supplyId}/orders/{orderId}
complete Order assembled Moved automatically when a supply with this order moved to the delivery PATCH /api/v3/supplies/{supplyId}/deliver
cancel Canceled by the supplier PATCH /api/v3/orders/{orderId}/cancel
cancel_missed_call Order cancellation due to unreachable customer.

For delivery by supplier (DBS)		 The status changes automatically

wbStatus is a status of an order on the Wildberries side.
Possible values for this field are:

  • waiting - the supplier confirmed the order, and the Wildberries has not received it yet.
  • sorted - the Wildberries warehouse sorted the order.
  • sold - the order is sold.
  • canceled - the supplier canceled the order.
  • canceled_by_client - the buyer canceled the order upon receipt.
  • declined_by_client - the buyer canceled the order in the first hour
    Cancellation is available to the buyer in the first hour from the moment of order, if the order is not transferred to confirm status.
  • defect - cancellation of the order due to a defect.
  • ready_for_pickup - the order came at pickup point and waiting the buyer.
  • canceled_by_missed_call - order cancellation due to unreachable customer. For delivery by supplier (DBS)
Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

Order IDs

Responses

Response Schema: application/json
Array of objects

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Get all orders for re-shipment

Returns all orders that require re-shipment

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array of objects

Orders list

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Cancel the order

Moves the order to cancel ("Canceled by the supplier") status.

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Add Data Matrix code to the order

The method allows to assign a Data Matrix code (Chestny ZNAK) to an assembly task. The assembly task cannot have more than 24 codes. You can add a code only for orders in the confirmed status.

The uploaded Data Matrix Codes can be retrieved using the GET method /api/v3/orders/{orderId}/meta
For more information about Data Matrix Codes please check: https://chestnyznak.ru/en/

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
sgtins
Array of strings [ 1 .. 24 ] items

List of Data Matrix codes.

Responses

Request samples

Content type
application/json
{
  • "sgtins": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Get orders stickers

Returns a list of stickers according to the requested orders. You can request a sticker in svg, zplv (vertical), zplh (horizontal) and png formats.

Method limitations:

  • You cannot request more than 100 stickers at a time (no more than 100 order IDs in a request).
  • The method returns stickers only for orders that are in assembly (in confirm status).
  • Available dimensions:
    580x400 px, with parameters `width` = 58, `height` = 40
    400x300 px, with parameters `width` = 40, `height` = 30
Authorizations:
HeaderApiKey
query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Sticker format

width
required
integer
Enum: 58 40

Sticker width

height
required
integer
Enum: 40 30

Sticker height

Request Body schema: application/json
orders
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ]

Order IDs

Responses

Response Schema: application/json
Array of objects

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "stickers": [
    ]
}

Get order metadata

Returns order metadata. Possible metadata is imei, uin, gtin, sgtin.
The method response returns the metadata available for the assembly job. Empty response means there is no metadata available for the order.

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Responses

Response Schema: application/json
object (Meta)

Order metadata

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Delete order metadata

Removes all order metadata values for the passed key. Possible metadata is imei, uin, gtin, sgtin.

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

query Parameters
key
string

Name of the metadata to remove (imei, uin, gtin)

Responses

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequest",
  • "message": "Incorrect request parameters"
}

Add UIN (unique identification number) to the order

Sets the UIN for the order. The order can only have one UIN. You can add the code only for orders in the confirmed status.

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
uin
required
string = 16 characters

UIN

Responses

Request samples

Content type
application/json
{
  • "uin": "1234567890123456"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Add IMEI to the order

Sets the IMEI for the order. The order can have only one IMEI. You can add the code only for orders in the confirmed status.

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
imei
required
string = 15 characters

IMEI

Responses

Request samples

Content type
application/json
{
  • "imei": "123456789012345"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Add GTIN to the order

Sets the GTIN (Belarus product unique identifier) for the order. The order can only have one GTIN. You can add the code only for orders in the confirmed status.

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
gtin
required
string = 13 characters

GTIN

Responses

Request samples

Content type
application/json
{
  • "gtin": "1234567890123"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Get a list of links to stickers that are required for cross-bordering

Returns a list of links to stickers that are required for cross-bordering.

Method limitations:

  • You cannot request more than 100 stickers at a time (no more than 100 order IDs in a request).
  • The method returns stickers only for orders that are in delivery (in complete status).
Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ]

Order IDs

Responses

Response Schema: application/json
Array of objects

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{}

Status history for cross-border orders

Returns status history for cross-border orders

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
Array of integers [ 1 .. 100 ] items

Orders IDs

Responses

Response Schema: application/json
Array of objects

Orders

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Orders with buyer information

The method allows getting information about the buyer by order ID.
Only for cross-border orders from Turkey

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Orders list

Responses

Response Schema: application/json
One of
Array of objects (DbsClientInfo)

Buyer information for dbs-order (Delivery by Seller )

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "orders": [
    ]
}

Supplies

Starting from February 13, working with orders of the DBS scheme will only be possible via designated URLs

Workflow:


1. Create a new supply using the POST method /api/v3/supplies. The response will include the identifier of the created supply in the format "WB-GI-1234567".
2. Add assembly tasks to the current new supply that you will take to the warehouse or pickup points using the PATCH method /api/v3/supplies/{supplyId}/orders/{orderId}. Please note that when adding assembly tasks to the supply, they will be set to the "confirm" status ("In assembly").
Note: Steps 3 - 8 are mandatory for deliveries to pickup points.
3. Create a box in the supply using the POST method /api/v3/supplies/{supplyId}/trbx.
4. Add orders to the box using the PATCH method /api/v3/supplies/{supplyId}/trbx/{trbxId}.
5. The list of boxes with orders can be obtained using the GET method /api/v3/supplies/{supplyId}/trbx.
6. Get box stickers using the POST method /api/v3/supplies/{supplyId}/trbx/stickers, print and attach the stickers to the boxes according to the distributed orders inside them.
7. You can delete boxes from the supply using the DELETE method /api/v3/supplies/{supplyId}/trbx. Please note that you can only delete boxes from the supply while it is in the assembly stage.
8. You can delete orders from the box using the DELETE method /api/v3/supplies/{supplyId}/trbx/{trbxId}/orders/{orderId}. Please note that you can only delete orders from the box while the supply is in the assembly stage.
9. After the supply is assembled with the necessary assembly tasks, you must transfer it for delivery using the PATCH method /api/v3/supplies/{supplyId}/deliver. If the supply wasn't handed over for delivery, than scanning its barcode or accepting the first product will automatically close the supply. Please note that when transferring assembly tasks for delivery, they will be automatically marked as complete ("In delivery").
10. The list of assembly tasks added to the supply can be obtained using the GET method /api/v3/supplies/{supplyId}/orders.
11. You can obtain all supplies available to the seller using the GET method /api/v3/supplies.
12. You can get the details of a specific supply using the GET method /api/v3/supplies/{supplyId}.
13. You can delete a supply using the DELETE method /api/v3/supplies/{supplyId}, provided that it is active and not associated with any assembly tasks.
14. The PATCH method /api/v3/supplies/{supplyId}/orders/{orderId} also allows you to move assembly tasks between active supplies. Please note that you cannot move an assembly task from a closed supply unless it requires re-shipping.
15. You can obtain the QR code of the supply using the GET method /api/v3/supplies/{supplyId}/barcode in svg, zpl, or png format. This is only available after the supply has been transferred for delivery.

Create a new supply

Supplies limitations:

  • Supplies applicable only for orders in the FBS (Fulfillment by Seller) delivery.
  • All orders added to supply automatically transferred from the new status to the confirm status.
  • Please note that if you will cancel (“Canceled by the seller”) the order, we will automatically remove it from the supply.
  • A supply can only be assembled from assembly jobs (orders) with the same dimensional type (cargoType). A new supply does not have a dimensional attribute. When the first order is added to a supply, the supply acquires the dimensional attribute of that order.
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
name
string [ 1 .. 128 ] characters

Supply name

Responses

Response Schema: application/json
id
string

Supply ID

Request samples

Content type
application/json
{
  • "name": "Some test supply"
}

Response samples

Content type
application/json
{
  • "id": "WB-GI-1234567"
}

Get a supplies list

Returns the supply list.

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Pagination parameter. Sets the limit for the amount of data returned.

next
required
integer <int64>

Pagination parameter. Sets the value from which to retrieve the next batch. It should start at 0 to get the full list of data. For the subsequent requests, you must take the value from the next field in the response.

Responses

Response Schema: application/json
next
integer <int64> (Next)

Pagination parameter. Sets the value from which to retrieve the next batch

Array of objects (Supply)

Response samples

Content type
application/json
{
  • "next": 13833711,
  • "supplies": [
    ]
}

Add the order to the supply

Adds an order to a supply and moves it to confirm status.
It can also move the order between active supplies. Or from a closed to an active supply, if the order requires reshipment.

Important!
It is possible to add an assembly job of any dimensioned type to an empty delivery.
After adding the first task, the delivery acquires the dimensional type of this task, see the value of the cargo Type field in the response of the "Get supply details" method.
After that, you can only add tasks to a delivery whose dimension type corresponds to that of the delivery.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

orderId
required
integer <int64>
Example: 5632423

Order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Get supply details

Returns supply details.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

Response Schema: application/json
id
string

Supply ID

done
boolean

An indication that the supply is closed

createdAt
string <date-time>

Supply creation date (RFC3339)

closedAt
string <date-time>

Supply close date (RFC3339)

scanDt
string <date-time>

Supply scan date (RFC3339)

name
string

Supply name

cargoType
integer
Enum: 0 1 2 3
Type of cargo in the supply:
0 - not defined
1 - normal
2 - ODC
3 - CD+

Response samples

Content type
application/json
{
  • "id": "WB-GI-1234567",
  • "done": true,
  • "createdAt": "2022-05-04T07:56:29Z",
  • "closedAt": "2022-05-04T07:56:29Z",
  • "scanDt": "2022-05-04T07:56:29Z",
  • "name": "My test supply",
  • "cargoType": 0
}

Delete the supply

Deleted the supply if it is active and does not contain any orders.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Get the supply orders

Returns orders assigned to the supply.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

Response Schema: application/json
Array of objects (SupplyOrder)

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Move the supply to the delivery

Closes the supply and moves all orders to complete (“In Delivery”) status. You cannot add any orders to the supply after it is closed.

If the supply wasn't handed over for delivery, than scanning its barcode or accepting the first product will automatically close the supply.

You can transfer the supply to delivery only if it contains at least one order and no empty boxes.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Get the supply QR code

Returns the QR code in svg, zplv (vertical), zplh (horizontal), png.
Available only after the supply has been transferred to the delivery. Available dimensions:

580x400 px
Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Sticker format

Responses

Response Schema: application/json
barcode
string

The encoded value of the sticker (supply id)

file
string <byte>

Base64 encoded sticker file in the requested format.

Response samples

Content type
application/json
{
  • "barcode": "WB-GI-12345678",
  • "file": "U3dhZ2dlciByb2Nrcw=="
}

Get supply boxes list

Returns supply boxes list with assigned orders.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

Response Schema: application/json
Array of objects (SupplyTrbx)

Response samples

Content type
application/json
{
  • "trbxes": [
    ]
}

Add boxes to the supply

Adds the required number of boxes to the supply. Available only while the supply is being assembled.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Request Body schema: application/json
amount
required
integer [ 1 .. 1000 ]

Boxes amount to add to the supply.

Responses

Response Schema: application/json
trbxIds
Array of strings non-empty

List of IDs of created boxes.

Request samples

Content type
application/json
{
  • "amount": 4
}

Response samples

Content type
application/json
{
  • "trbxIds": [
    ]
}

Delete boxes from the supply

Removes orders from the listed delivery boxes and deletes the boxes. Available only while the supply is being assembled.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Request Body schema: application/json
trbxIds
required
Array of strings

List of box IDs to delete from the supply.

Responses

Request samples

Content type
application/json
{
  • "trbxIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Add orders to the box

Add orders to the supply box. Available only while the supply is being assembled.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

trbxId
required
string
Example: WB-TRBX-1234567

Box ID

Request Body schema: application/json
orderIds
required
Array of integers

List of orders to be added to the box.

Responses

Request samples

Content type
application/json
{
  • "orderIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Delete order from the box

Deletes order from the supply box. Available only while the supply is being assembled.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

trbxId
required
string
Example: WB-TRBX-1234567

Box ID

orderId
required
integer <int64>
Example: 5632423

Order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Get the supply box QR code stickers

Returns QR-code stickers in svg, zplv (vertical), zplh (horizontal), png.
Available only if there are orders in the box.

Stickers dimensions: 580x400 px
Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Sticker format

Request Body schema: application/json
trbxIds
required
Array of strings

List of supply box IDs for the sticker generation

Responses

Response Schema: application/json
Array of objects (TrbxStickers) non-empty

Request samples

Content type
application/json
{
  • "trbxIds": [
    ]
}

Response samples

Content type
application/json
{
  • "stickers": [
    ]
}

Stocks

Update stocks

Updates the supplier's stocks.
Important! The names of the query parameters are not validated. If invalid names are sent, the response will be successful(204), but the remaining amounts will not be updated.
Check the data carefully before submitting it.

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Request Body schema: application/json
required
Array of objects [ 1 .. 1000 ] items

SKU array

Responses

Request samples

Content type
application/json
{
  • "stocks": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Delete stocks

Deletes the supplier's stocks. Caution! This action is irreversible. Deleted stock will require re-uploading to continue sales.

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Request Body schema: application/json
required
skus
Array of strings [ 1 .. 1000 ] items

SKUs array

Responses

Request samples

Content type
application/json
{
  • "skus": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Get stocks

Returns the supplier's stocks.

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Request Body schema: application/json
required
skus
Array of strings [ 1 .. 1000 ] items

SKUs array

Responses

Response Schema: application/json
Array of objects

Request samples

Content type
application/json
{
  • "skus": [
    ]
}

Response samples

Content type
application/json
{
  • "stocks": [
    ]
}

Warehouses

Get offices

Returns a list of all offices to link to supplier warehouse.

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array
address
string

Address

name
string

Name

city
string

City

id
integer <int64>

ID

longitude
number <float64>

Longitude

latitude
number <float64>

Latitude

cargoType
integer
Enum: 1 2 3
The type of goods a warehouse can accept:
1 - normal
2 - ODC
3 - CD+
deliveryType
integer
Enum: 1 2 3
The type of deliveries that the warehouse can accept:
1 - 'Fulfillment By Wildberries'
2 - 'Delivery By Supplier'
3 - 'Delivery by WB courier'
selected
boolean

The flag indicating that the office has already been selected by the supplier

Response samples

Content type
application/json
[
  • {
    }
]

Get warehouses

Returns a list of all supplier's warehouses.

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array
name
string

Name

officeId
integer <int64>

Office ID

id
integer <int64>

ID

cargoType
integer
Enum: 1 2 3
The type of goods a warehouse can accept:
1 - normal
2 - ODC
3 - CD+
deliveryType
integer
Enum: 1 2 3
The type of deliveries that the warehouse can accept:
1 - 'Fulfillment By Wildberries'
2 - 'Delivery By Supplier'
3 - 'Delivery by WB courier'

Response samples

Content type
application/json
[
  • {
    }
]

Create warehouse

Creates a supplier's warehouse. You cannot link an office that is already in use.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Supplier's warehouse name

officeId
required
integer >= 1

Office ID

Responses

Response Schema: application/json
id
integer

Warehouse ID

Request samples

Content type
application/json
{
  • "name": "Koledino 2",
  • "officeId": 15
}

Response samples

Content type
application/json
{
  • "id": 2
}

Update warehouse

Updates the supplier's warehouse details. Changing the linked office is allowed once per day. You cannot link an office that is already in use.

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Supplier's warehouse name

officeId
required
integer >= 1

Office ID

Responses

Request samples

Content type
application/json
{
  • "name": "Koledino",
  • "officeId": 15
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Delete warehouse

Deletes the supplier's warehouse.

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Responses

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Passes

Get offices for pass

Returns a list of offices that require a pass.

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array
name
string

Name

address
string

Address

id
integer <int64>

ID

Response samples

Content type
application/json
[
  • {
    }
]

Get passes

Returns a list of all supplier's passes.

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array
firstName
string

First name

dateEnd
string

Pass expiration date

lastName
string

Last name

carModel
string

Car model

carNumber
string

Car number

officeName
string

Office name

officeAddress
string

Office address

officeId
integer <int64>

Office ID

id
integer <int64>

ID

Response samples

Content type
application/json
[
  • {
    }
]

Create pass

Creates a supplier pass.
The pass is valid for 48 hours from the time of creation. The method is limited to one call per 10 minutes.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required

The total length of the full name is limited from 6 to 100 characters. The car number can contain only letters and numbers.

firstName
required
string non-empty

First name

lastName
required
string non-empty

Last name

carModel
required
string [ 1 .. 100 ] characters

Car model

carNumber
required
string [ 6 .. 9 ] characters

Car number

officeId
required
integer <int64> >= 1

Office ID

Responses

Response Schema: application/json
id
integer

Pass ID

Request samples

Content type
application/json
{
  • "firstName": "Alex",
  • "lastName": "Petrov",
  • "carModel": "Lamborghini",
  • "carNumber": "A456BC123",
  • "officeId": 15
}

Response samples

Content type
application/json
{
  • "id": 2
}

Update pass

Updates the supplier's pass details.

Authorizations:
HeaderApiKey
path Parameters
passId
required
integer <int64>
Example: 45

Pass ID

Request Body schema: application/json
required

The total length of the full name is limited from 6 to 100 characters. The car number can contain only letters and numbers.

firstName
required
string non-empty

First name

lastName
required
string non-empty

Last name

carModel
required
string [ 1 .. 100 ] characters

Car model

carNumber
required
string [ 6 .. 9 ] characters

Car number

officeId
required
integer <int64> >= 1

Office ID

Responses

Request samples

Content type
application/json
{
  • "firstName": "Alex",
  • "lastName": "Petrov",
  • "carModel": "Lamborghini",
  • "carNumber": "A456BC123",
  • "officeId": 15
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Delete the pass

Deletes the supplier's pass.

Authorizations:
HeaderApiKey
path Parameters
passId
required
integer <int64>
Example: 45

Pass ID

Responses

Response samples

Content type
application/json
{
  • "title": "unauthorized",
  • "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
  • "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
  • "requestId": "7b80742415072fe8b6b7f7761f1d1211",
  • "origin": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

WB Courier Delivery (WBGO)

To access the methods, use a token for the Marketplace category

How to work:

  1. Receive a new order with "deliveryType": "wbgo"
  2. Transfer it for assembly
  3. Get and print order stickers
  4. Transfer to delivery
  5. Waiting for the courier
  6. The courier picks up the order and delivers it to the customer
  7. The customer accepts or declines the order
  8. If the customer accepts the order, the task is automatically set to the status receive. If declined, it sets to reject
A total maximum of 300 requests per minute for all methods

Transfer to assembly

Transfers the order to the status confirm ("On assembly")

Authorizations:
HeaderApiKey
path Parameters
order
required
integer <int64>
Example: 5632423

Order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Transfer to delivery

Transfers order to the status complete — in delivery

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Contacts list

Returns a list of contacts linked to the seller's warehouse

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Responses

Response Schema: application/json
Array
Array of objects

Response samples

Content type
application/json
[
  • {
    }
]

Update contacts list

Updates the seller's warehouse contact list.

The contact list is overwritten upon update. Therefore, you need to include all contact list parameters in the request, including those you do not intend to update.

Only for warehouses with delivery type 3 — WB courier.

A maximum of 5 contacts can be added to the warehouse.
To delete contacts, send an empty contacts array

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 2

The supplier's warehouse ID

Request Body schema: application/json
required
Array of objects <= 5 items

Responses

Request samples

Content type
application/json
{
  • "contacts": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Orders (DBS)

How to work:

  1. Obtain the new order and save it until it is ready for assembly. If you do not save the order information in advance, you will only be able to access it after the order is completed (either canceled or sold)
  2. Transfer it for assembly
  3. Transfer to delivery
  4. After the order is transferred to assembly, buyer information (name, phone) becomes available.
  5. After delivering the task to the buyer, you need to notify our server that the order was accepted by the buyer or that the buyer declined the order.

Get new orders list

Returns a list of all new orders for the seller at the moment

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array of objects (OrderNewDBS)

New orders list

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Get information on completed orders

Returns information on completed orders (either canceled or sold)

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Pagination parameter. Sets the limit for the amount of data returned.

next
required
integer <int64>

Pagination parameter. Sets the value from which to retrieve the next batch. It should start at 0 to get the full list of data. For the subsequent requests, you must take the value from the next field in the response.

dateFrom
required
integer

Period start date in Unix timestamp format

dateTo
required
integer

Period end date in Unix timestamp format

Responses

Response Schema: application/json
next
integer <int64> (Next)

Pagination parameter. Sets the value from which to retrieve the next batch

Array of objects (OrderDBS)

Response samples

Content type
application/json
{
  • "next": 13833711,
  • "orders": [
    ]
}

Buyer information

The method allows getting information about the buyer by order ID

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Orders list

Responses

Response Schema: application/json
Array of objects (DbsClientInfo)

Buyer information for dbs-order (Delivery by Seller )

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Get orders statuses

Returns the statuses of orders based on the provided list of order IDs.

Possible values for this field are:

Status Description How to move an order to this status
new New order
confirm Order on assembly Transfer to assembly
deliver Order on delivery
 Transfer to delivery
receive Received by the buyer
 Notify that the order has been accepted by the buyer
reject Declined upon receipt
 Notify that the buyer has declined the order
cancel Canceled by the supplier Cancel the order
cancel_missed_call Order cancellation due to unreachable customer
 The status changes automatically

wbStatus is a status of an order on the Wildberries side.
Possible values for this field are:

  • waiting - order in work
  • sorted - order sorted
  • sold - the buyer got the order
  • canceled - order canceled
  • canceled_by_client - the buyer canceled the order
  • declined_by_client - the buyer canceled the order in the first hour
    Cancellation is available to the buyer in the first hour from the moment of order, if the order is not transferred to confirm status.
  • defect - order canceled due to a defect
  • ready_for_pickup - the order arrived the pickup point
  • canceled_by_missed_call - order cancellation due to unreachable customer. For delivery by supplier
Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

Orders IDs list

Responses

Response Schema: application/json
Array of objects

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Cancel the order

Moves the order to cancel ("Canceled by the supplier") status

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Transfer to assembly

Transfers the order to the status confirm ("On assembly")

Authorizations:
HeaderApiKey
path Parameters
order
required
integer <int64>
Example: 5632423

Order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Transfer to delivery

Transfers the order to the status deliver ("In delivery")

Authorizations:
HeaderApiKey
path Parameters
order
required
integer <int64>
Example: 5632423

Order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Notify that the order has been accepted by the buyer

Transfers the order to the status receive ("Received by the buyer")

Authorizations:
HeaderApiKey
path Parameters
order
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
required
code
string

Confirmation Code.
Displayed to the buyer on the website and in the Wildberries app

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Notify that the buyer has declined the order

Transfers to the status reject ("Declined upon receipt")

Authorizations:
HeaderApiKey
path Parameters
order
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
required
code
string

Confirmation Code.
Displayed to the buyer on the website and in the Wildberries app

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter value"
}

Metadata (DBS)

Get order metadata

Returns order metadata. Possible metadata is imei, uin, gtin, sgtin.
The method response returns the metadata available for the assembly job. Empty response means there is no metadata available for the order

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Responses

Response Schema: application/json
object (Meta)

Order metadata

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Delete order metadata

Removes all order metadata values for the passed key. Possible metadata is imei, uin, gtin, sgtin

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

query Parameters
key
string

Name of metadata to delete (imei, uin, gtin, sgtin). Only one value is passed.

Responses

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequest",
  • "message": "Incorrect request parameters"
}

Add Data Matrix code to the order (Chestny ZNAK)

This method allows you to assign a Data Matrix code (Chestny ZNAK marking) to an order.
The assignment of a Data Matrix code to an order is only possible if this field is returned in the response of the Get order metadata method and the order is in the confirm status.

You can retrieve the uploaded Data Matrix code using the Get order metadata method.
For more information about Data Matrix Codes please check: https://chestnyznak.ru/en/

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
sgtins
Array of strings [ 1 .. 24 ] items

List of Data Matrix codes.From 16 to 135 characters for one label.

Responses

Request samples

Content type
application/json
{
  • "sgtins": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Add UIN (unique identification number) to the order

Sets the UIN for the order. The order can only have one UIN. You can add the code only for orders in the confirmed status and that are delivered by Wildberries

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
uin
required
string = 16 characters

UIN

Responses

Request samples

Content type
application/json
{
  • "uin": "1234567890123456"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Add IMEI to the order

Sets the IMEI for the order. The order can have only one IMEI. You can add the code only for orders in the confirmed status and that are delivered by Wildberries

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
imei
required
string = 15 characters

IMEI

Responses

Request samples

Content type
application/json
{
  • "imei": "123456789012345"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}

Add GTIN to the order

Sets the GTIN (Belarus product unique identifier) for the order. The order can only have one GTIN. You can add the code only for orders in the confirmed status and that are delivered by Wildberries

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Request Body schema: application/json
gtin
required
string = 13 characters

GTIN

Responses

Request samples

Content type
application/json
{
  • "gtin": "1234567890123"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Incorrect request body"
}