DBS Orders (order)
Management of orders, metadata
How to work:
- 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)
- Transfer it for assembly
- Transfer to delivery
- After the order is transferred to assembly, buyer information (name, phone) becomes available.
- 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
Authorizations:
Responses
Response samples
- 200
- 401
- 403
- 429
{- "orders": [
- {
- "address": {
- "fullAddress": "Chelyabinsk Region, Chelyabinsk, 51st Arabkir Street, Building 10A, Apartment 42",
- "longitude": 44.519068,
- "latitude": 40.20192
}, - "ddate": "17.05.2024",
- "salePrice": 504600,
- "dTimeFrom": "15:00",
- "dTimeTo": "16:00",
- "requiredMeta": [
- "uin"
], - "deliveryType": "dbs",
- "comment": "Упакуйте в плёнку, пожалуйста",
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "nmId": 123456789,
- "chrtId": 987654321,
- "price": 1014,
- "convertedPrice": 28322,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "isZeroOrder": false
}
]
}Get information on completed orders{{ /api/v3/dbs/orders }}
Returns information on completed orders (either canceled or sold)
Authorizations:
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 |
| dateFrom required | integer Period start date in Unix timestamp format |
| dateTo required | integer Period end date in Unix timestamp format |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
{- "next": 13833711,
- "orders": [
- {
- "address": {
- "fullAddress": "Chelyabinsk Region, Chelyabinsk, 51st Arabkir Street, Building 10A, Apartment 42",
- "province": "Chelyabinsk Region",
- "area": "Chelyabinsk",
- "city": "City",
- "street": "51st Arabkir Street",
- "home": "10А",
- "flat": "42",
- "entrance": "3",
- "longitude": 44.519068,
- "latitude": 40.20192
}, - "deliveryType": "dbs",
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "nmId": 12345678,
- "chrtId": 987654321,
- "price": 1014,
- "convertedPrice": 28322,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "comment": "Упакуйте в плёнку, пожалуйста",
- "isZeroOrder": false
}
]
}Buyer information{{ /api/v3/dbs/orders/client }}
The method allows getting information about the buyer by order ID
Authorizations:
Request Body schema: application/jsonrequired
| orders | Array of integers Orders list |
Responses
Request samples
- Payload
{- "orders": [
- 987654321,
- 123456789
]
}Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "orders": [
- {
- "firstName": "Иван",
- "fullName": "Иванов Иван Иванович",
- "orderID": 134567,
- "phone": 79871234567,
- "phoneCode": 1234567,
- "additionalPhoneCodes": [
- 12345,
- 65498
]
}
]
}Get orders statuses{{ /api/v3/dbs/orders/status }}
Returns the statuses of orders based on the provided list of order IDs
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 | 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:
Request Body schema: application/json
| orders required | Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ] Orders IDs list |
Responses
Request samples
- Payload
{- "orders": [
- 5632423
]
}Response samples
- 200
- 400
- 401
- 403
- 429
{- "orders": [
- {
- "id": 5632423,
- "supplierStatus": "new",
- "wbStatus": "waiting"
}
]
}Cancel the order{{ /api/v3/dbs/orders/{orderId}/cancel }}
Moves the order to cancel ("Canceled by the supplier") status
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 Order ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}Transfer to assembly{{ /api/v3/dbs/orders/{order}/confirm }}
Transfers the order to the status confirm ("On assembly")
Authorizations:
path Parameters
| order required | integer <int64> Example: 5632423 Order ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}Transfer to delivery{{ /api/v3/dbs/orders/{order}/deliver }}
Transfers the order to the status deliver ("In delivery")
Authorizations:
path Parameters
| order required | integer <int64> Example: 5632423 Order ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}Notify that the order has been accepted by the buyer{{ /api/v3/dbs/orders/{order}/receive }}
Transfers the order to the status receive ("Received by the buyer")
Authorizations:
path Parameters
| order required | integer <int64> Example: 5632423 Order ID |
Request Body schema: application/jsonrequired
| code | string Confirmation сode. Displayed to the buyer on the website and in the Wildberries app |
Responses
Request samples
- Payload
{- "code": "123456"
}Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}Notify that the buyer has declined the order{{ /api/v3/dbs/orders/{order}/reject }}
Transfers to the status reject ("Declined upon receipt")
Authorizations:
path Parameters
| order required | integer <int64> Example: 5632423 Order ID |
Request Body schema: application/jsonrequired
| code | string Confirmation сode. Displayed to the buyer on the website and in the Wildberries app |
Responses
Request samples
- Payload
{- "code": "123456"
}Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}Get order metadata{{ /api/v3/dbs/orders/{orderId}/meta }}
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:
path Parameters
| orderId required | integer <int64> Example: 5632423 Order ID |
Responses
Response samples
- 200
- 401
- 403
- 404
- 429
{- "meta": {
- "imei": {
- "value": 123456789012345
}, - "uin": {
- "value": 123456789012345
}, - "gtin": {
- "value": 123456789012345
}, - "sgtin": {
- "value": [
- 123456789012345
]
}
}
}Delete order metadata{{ /api/v3/dbs/orders/{orderId}/meta }}
Removes all order metadata values for the passed key. Possible metadata is imei, uin, gtin, sgtin.
Authorizations:
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
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectRequest",
- "message": "Incorrect request parameters"
}Add Data Matrix code to the order (Chestny ZNAK){{ /api/v3/dbs/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/
1. Assign UIN to the order
2. Assign IMEI to the order
3. Assign GTIN to the order
4. Assign Data Matrix code to the order
Authorizations:
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
- Payload
{- "sgtins": [
- "1234567890123456"
]
}Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Incorrect request body"
}Add UIN (unique identification number) to the order{{ /api/v3/dbs/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 and that are delivered by Wildberries
1. Assign UIN to the order
2. Assign IMEI to the order
3. Assign GTIN to the order
4. Assign Data Matrix code to the order
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 Order ID |
Request Body schema: application/json
| uin required | string = 16 characters UIN |
Responses
Request samples
- Payload
{- "uin": "1234567890123456"
}Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Incorrect request body"
}Add IMEI to the order{{ /api/v3/dbs/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 and that are delivered by Wildberries
1. Assign UIN to the order
2. Assign IMEI to the order
3. Assign GTIN to the order
4. Assign Data Matrix code to the order
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 Order ID |
Request Body schema: application/json
| imei required | string = 15 characters IMEI |
Responses
Request samples
- Payload
{- "imei": "123456789012345"
}Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Incorrect request body"
}Add GTIN to the order{{ /api/v3/dbs/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 and that are delivered by Wildberries
1. Assign UIN to the order
2. Assign IMEI to the order
3. Assign GTIN to the order
4. Assign Data Matrix code to the order
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 Order ID |
Request Body schema: application/json
| gtin required | string = 13 characters GTIN |
Responses
Request samples
- Payload
{- "gtin": "1234567890123"
}Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Incorrect request body"
}