Search
API docs by Redocly

DBS Orders (order)

Management of orders, metadata

DBS Orders

Management of orders, metadata

DBS Assembly Orders

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

How to work:

  1. Get 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). Check the delivery date and time.
  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{{ /api/v3/dbs/orders/new }}

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

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

Request limit per one seller's account for DBS assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests
Authorizations:
HeaderApiKey

Responses

Response samples

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

Get Information on Completed Orders{{ /api/v3/dbs/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 DBS assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 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": [
    ]
}

Get Information on Paid Delivery{{ /api/v3/dbs/groups/info }}

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

The method provides information on paid delivery for assembly orders that have been received at a single warehouse (warehouseId) as part of a single buyer transaction (orderUid).

Request limit per one seller's account for DBS assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
groups
Array of strings <= 1000 items

List of groupId values. Can be obtained from new and completed assembly orders.

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Buyer Information{{ /api/v3/dbs/orders/client }}

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

The method allows getting information about the buyer by order ID

Request limit per one seller's account for DBS assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 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

Assembly orders ID list

Responses

Request samples

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

Response samples

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

B2B Buyer Information{{ /api/marketplace/v3/dbs/orders/b2b/info }}

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

The method returns B2B buyers data by assembly orders ID:

  • Taxpayer Identification Number (TIN or INN in Russian)
  • Code of Reason for Registration (CRR or KPP in Russian)
  • Company name
Request limit per one seller's account for DBS assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Delivery Date and Time{{ /api/v3/dbs/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 DBS assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers[ items [ 1 .. 1000 ] items ]

List of orders IDs

Responses

Request samples

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

Response samples

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

Get Assembly Order Statuses{{ /api/marketplace/v3/dbs/orders/status/info }}

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

Returns the statuses of assembly orders based on the 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
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 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 — assembly order in work
  • sold — the buyer got the order
  • canceled — assembly 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 assembly order arrived the pickup point
  • canceled_by_missed_call— cancellation due to unreachable buyer. For delivery by supplier
Request limit per one seller's account for DBS assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

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

Cancel Assembly Orders{{ /api/marketplace/v3/dbs/orders/status/cancel }}

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

The method transfers assembly orders with the statuses new, confirm и deliver to the status cancel — canceled by the supplier.

Request limit per one seller's account:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Transfer to Assembly{{ /api/marketplace/v3/dbs/orders/status/confirm }}

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

The method transfers assembly orders with the new status to the confirm status — order on assembly.

Request limit per one seller's account:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Transfer to Delivery{{ /api/marketplace/v3/dbs/orders/status/deliver }}

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

The method transfers assembly orders with the confirm status to the deliver status — order on delivery.

Request limit per one seller's account:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Notify that the Orders Are Received{{ /api/marketplace/v3/dbs/orders/status/receive }}

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

The method transfers assembly orders with the deliver status to the receive status — received by the buyer.

Request limit per one seller's account:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array of objects (api.OrderCodeRequest) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Notify that the Orders Are Declined{{ /api/marketplace/v3/dbs/orders/status/reject }}

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

The method transfers assembly orders with the deliver status to the reject status — declined upon receipt.

Request limit per one seller's account:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array of objects (api.OrderCodeRequest) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Get orders statuses{{ /api/v3/dbs/orders/status }} Deprecated

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

This method is deprecated. It will be removed on April 13

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": [
    ]
}

Cancel the Order{{ /api/v3/dbs/orders/{orderId}/cancel }} Deprecated

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

This method is deprecated. It will be removed on April 13

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

Assembly order ID

Responses

Response samples

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

Transfer to Assembly{{ /api/v3/dbs/orders/{orderId}/confirm }} Deprecated

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

This method is deprecated. It will be removed on April 13

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

Assembly order ID

Responses

Response samples

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

Transfer to Delivery{{ /api/v3/dbs/orders/{orderId}/deliver }} Deprecated

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

This method is deprecated. It will be removed on April 13

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

Assembly order ID

Responses

Response samples

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

Notify That the Order Has Been Accepted by the Buyer{{ /api/v3/dbs/orders/{orderId}/receive }} Deprecated

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

This method is deprecated. It will be removed on April 13

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

Assembly 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": "123456"
}

Response samples

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

Notify That the Buyer Has Declined the Order{{ /api/v3/dbs/orders/{orderId}/reject }} Deprecated

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

This method is deprecated. It will be removed on April 13

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

Assembly 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": "123456"
}

Response samples

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

DBS Metadata

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

Get Assembly Orders Metadata{{ /api/marketplace/v3/dbs/orders/meta/info }}

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

Returns assembly orders metadata.
You can get the list of metadata available for the assembly order via the list of new assembly orders method, field requiredMeta.
Possible metadata:

If the response has an empty meta structure, the assembly order has no metadata and you can't add it.

Request limit per one seller's account for all methods for getting and deleting DBS metadata:
Period Limit Interval Burst
1 min 150 requests 400 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

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

Delete Assembly Orders Metadata{{ /api/marketplace/v3/dbs/orders/meta/delete }}

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

Removes all assembly order metadata values.

You can only remove one type of metadata in one request. Specify the metadata type in the request:

Request limit per one seller's account for all methods for getting and deleting DBS metadata:
Period Limit Interval Burst
1 min 150 requests 400 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
key
required
string

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

orderIds
required
Array of integers <= 1000 items

Assembly orders IDs list

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Add Data Matrix Codes to Assembly Orders (Chestny ZNAK){{ /api/marketplace/v3/dbs/orders/meta/sgtin }}

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

Sets the Data Matrix code (Chestny ZNAK marking) for the assembly orders.
You can set the Data Matrix code only for orders in the confirmed status and if the field sgtin is returned in the response of 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 DBS metadata:
Period Limit Interval Burst
1 min 500 requests 120 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array of objects (api.SGTINs) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Add UIN (Unique Identification Number) to Assembly Orders{{ /api/marketplace/v3/dbs/orders/meta/uin }}

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

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

Request limit per one seller's account for all methods for adding DBS metadata:
Period Limit Interval Burst
1 min 500 requests 120 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array of objects (api.UIN) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Add IMEI to Assembly Orders{{ /api/marketplace/v3/dbs/orders/meta/imei }}

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

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

Request limit per one seller's account for all methods for adding DBS metadata:
Period Limit Interval Burst
1 min 500 requests 120 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array of objects (api.IMEI) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Add GTIN to Assembly Orders{{ /api/marketplace/v3/dbs/orders/meta/gtin }}

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

Sets the GTIN, Belarus product unique identifier, for the assembly order metadata(./orders-dbs#tag/DBS-Metadata/paths/1api1marketplace1v31dbs1orders1meta1info/post).
The assembly order can only have one GTIN. You can set the GTIN only for orders in the confirmed [status](./orders-dbs#tag/DBS-Assembly-Orders/paths/1api1marketplace1v31dbs1orders1status1info/post) and that are delivered by Wildberries.

Request limit per one seller's account for all methods for adding DBS metadata:
Period Limit Interval Burst
1 min 500 requests 120 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
Array of objects (api.GTIN) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4Of-fd3ac0fad2сc",
  • "results": [
    ]
}

Add Custom Declaration to the Orders{{ /api/marketplace/v3/dbs/orders/meta/customs-declaration }}

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

Sets the cargo customs declaration number in the metadata of the assembly orders.

One assembly order can have only one cargo customs declaration number.

The customs declaration number can only be added to assembly orders that are in deliver status.

Request limit per one seller's account for all methods for adding DBS metadata:
Period Limit Interval Burst
1 min 500 requests 120 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
Array of objects <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
Example

Incorrect request body

{
  • "code": "IncorrectRequestBody",
  • "message": ""
}

Get order metadata{{ /api/v3/dbs/orders/{orderId}/meta }} Deprecated

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

This method is deprecated. It will be removed on April 13

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/dbs/orders/{orderId}/meta }} Deprecated

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

This method is deprecated. It will be removed on April 13

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
{
  • "message": "Incorrect parameter value"
}

Add Data Matrix Code to the Order{{ /api/v3/dbs/orders/{orderId}/meta/sgtin }} Deprecated

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

This method is deprecated. It will be removed on April 13

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

Incorrect request body

{
  • "code": "IncorrectRequestBody",
  • "message": ""
}

Add UIN (Unique Identification Number) to the Order{{ /api/v3/dbs/orders/{orderId}/meta/uin }} Deprecated

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

This method is deprecated. It will be removed on April 13

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

Incorrect request body

{
  • "code": "IncorrectRequestBody",
  • "message": ""
}

Add IMEI to the Order{{ /api/v3/dbs/orders/{orderId}/meta/imei }} Deprecated

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

This method is deprecated. It will be removed on April 13

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

Incorrect request body

{
  • "code": "IncorrectRequestBody",
  • "message": ""
}

Add GTIN to the Order{{ /api/v3/dbs/orders/{orderId}/meta/gtin }} Deprecated

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

This method is deprecated. It will be removed on April 13

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

Incorrect request body

{
  • "code": "IncorrectRequestBody",
  • "message": ""
}