Search
API docs by Redocly

DBW Orders (ordersdbw)

Managing assembly orders and metadata of DBW (Delivery by WB Courier) orders.

DBW Orders

Managing assembly orders and metadata of DBW (Delivery by WB Courier) orders.

DBW Assembly Orders

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

How to work with DBW assembly orders:

  1. Get a new assembly order.
  2. Transfer it for assembly.
  3. After the assembly order is moved to assembly, information about the courier (phone, vehicle number) becomes available. To allow the courier to contact you, link your contacts to the warehouse. You can also get the current list of your contacts.
  4. Get, print, and attach the stickers.
  5. Transfer to delivery.
  6. Waiting for the courier.
  7. The courier picks up the order and delivers it to the byuer.
  8. The byuer accepts or declines the order.
  9. If the byuer accepts the order, the courier changes the assembly order status to receive. If the buyer declines, it is changed to reject.

Get new orders{{ /api/v3/dbw/orders/new }}

Описание метода

Returns a list of all new orders.

Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests
Authorizations:
HeaderApiKey

Responses

Response samples

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

Get information on completed orders{{ /api/v3/dbw/orders }}

Описание метода

Returns information on completed orders (either canceled or sold).
You can get data for a specified period, maximum of 30 calendar days per request.

Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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 samples

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

Delivery date and time{{ /api/v3/dbw/orders/delivery-date }}

Описание метода

Method provides information about the delivery date and time selected by the buyer for orders.

Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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

Assembly orders ID list

Responses

Request samples

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

Response samples

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

Get orders statuses{{ /api/v3/dbw/orders/status }}

Описание метода

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

supplierStatus is a status of an order. The trigger for its change is the action of the seller himself.
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
complete Order on delivery
 Transfer to delivery
receive Received by the buyer
 Changed by the courier
reject Declined upon receipt
 Changed by the courier
cancel Canceled by the seller Cancel the order
cancel_missed_call Cancellation due to unreachable buyer 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
  • 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
  • canceled_by_missed_call — cancellation due to unreachable buyer
  • postponed_delivery — courier delivery is postponed
Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

Orders IDs list

Responses

Request samples

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

Response samples

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

Transfer to assembly{{ /api/v3/dbw/orders/{orderId}/confirm }}

Описание метода

Transfers the assembly order to the confirm status — on assembly.

Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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

Assembly order ID

Responses

Response samples

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

Get orders stickers{{ /api/v3/dbw/orders/stickers }}

Описание метода

Returns a list of stickers according to the assembly 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 assembly order IDs in a request).
  • The method returns stickers only for orders that are in assembly (in confirm status).
  • Available dimensions:
    • 580x400 px, with width=58&height=40 in request
    • 400x300 px, with width=40&height=30 in request
Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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 > ]

Assembly orders ID list

Responses

Request samples

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

Response samples

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

Transfer to delivery{{ /api/v3/dbw/orders/{orderId}/assemble }}

Описание метода

Transfers the assembly order to the status complete — in delivery.

Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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

Assembly order ID

Responses

Response samples

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

Courier info{{ /api/v3/dbw/orders/courier }}

Описание метода

Method provides the courier's contact information and vehicle number based on the assembly order ID. For assembly orders in the statuses confirm and complete.

Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Assembly orders ID list

Responses

Request samples

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

Response samples

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

Cancel the order{{ /api/v3/dbw/orders/{orderId}/cancel }}

Описание метода

Moves the assembly order to cancel status — canceled by the seller.

Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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

Assembly order ID

Responses

Response samples

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

DBW Metadata

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

Get order metadata{{ /api/v3/dbw/orders/{orderId}/meta }}

Описание метода

Returns assembly order metadata.

The list of metadata available for the assembly order can be obtained in the list of new assembly orders, field requiredMeta.

Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Assembly order ID

Responses

Response samples

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

Delete order metadata{{ /api/v3/dbw/orders/{orderId}/meta }}

Описание метода

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

Request limit per one seller's account for DBW methods:
  • for getting and updating contact lists
  • for getting and deleting metadata
  • assembly orders
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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

Assembly 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": "IncorrectParameter",
  • "message": ""
}

Add Data Matrix code to the order (Chestny ZNAK){{ /api/v3/dbw/orders/{orderId}/meta/sgtin }}

Описание метода

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/

Request limit per one seller's account for all methods for adding metadata DBW model:
Period Limit Interval Burst
1 minute 1000 requests 60 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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

Assembly 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

Некорректное тело запроса

{
  • "message": ""
}

Add UIN (unique identification number) to the order{{ /api/v3/dbw/orders/{orderId}/meta/uin }}

Описание метода

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.

Request limit per one seller's account for all methods for adding metadata DBW model:
Period Limit Interval Burst
1 minute 1000 requests 60 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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

Assembly 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

Некорректное тело запроса

{
  • "message": ""
}

Add IMEI to the order{{ /api/v3/dbw/orders/{orderId}/meta/imei }}

Описание метода

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.

Request limit per one seller's account for all methods for adding metadata DBW model:
Period Limit Interval Burst
1 minute 1000 requests 60 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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

Assembly 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

Некорректное тело запроса

{
  • "message": ""
}

Add GTIN to the order{{ /api/v3/dbw/orders/{orderId}/meta/gtin }}

Описание метода

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.

Request limit per one seller's account for all methods for adding metadata DBW model:
Period Limit Interval Burst
1 minute 1000 requests 60 milliseconds 20 requests

One request with a response code of 409 is counted as 10 requests

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

Assembly 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

Некорректное тело запроса

{
  • "message": ""
}