FBS Orders (order)
Management of Orders, deliveries, warehouses, and passes
Get offices{{ /api/v3/offices }}
Returns a list of all offices to link to seller warehouse.
Authorizations:
Responses
Response samples
- 200
- 401
- 403
- 429
[- {
- "address": "Kosmonavtov 10А",
- "name": "Koledino",
- "city": "Vyborg",
- "id": 15,
- "longitude": 55.386871,
- "latitude": 37.588898,
- "cargoType": 1,
- "deliveryType": 1,
- "selected": true
}
]
Create warehouse{{ /api/v3/warehouses }}
Creates a seller's warehouse. You cannot link an office that is already in use.
Authorizations:
Request Body schema: application/jsonrequired
name required | string [ 1 .. 200 ] characters Supplier's warehouse name |
officeId required | integer >= 1 Office ID |
Responses
Request samples
- Payload
{- "name": "Koledino 2",
- "officeId": 15
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 409
- 429
{- "id": 2
}
Update warehouse{{ /api/v3/warehouses/{warehouseId} }}
Updates the seller's warehouse details. Changing the linked office is allowed once per day. You cannot link an office that is already in use
Authorizations:
path Parameters
warehouseId required | integer <int64> Example: 1 Warehouse ID |
Request Body schema: application/jsonrequired
name required | string [ 1 .. 200 ] characters Supplier's warehouse name |
officeId required | integer >= 1 Office ID |
Responses
Request samples
- Payload
{- "name": "Koledino",
- "officeId": 15
}
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Incorrect request body"
}
Delete warehouse{{ /api/v3/warehouses/{warehouseId} }}
Deletes the supplier's warehouse.
Authorizations:
path Parameters
warehouseId required | integer <int64> Example: 1 Warehouse ID |
Responses
Response samples
- 401
- 403
- 404
- 429
{- "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"
}
Get passes{{ /api/v3/passes }}
Returns a list of all seller's passes.
Authorizations:
Responses
Response samples
- 200
- 401
- 403
- 429
[- {
- "firstName": "Alex",
- "dateEnd": "2022-07-31 17:53:13+00:00",
- "lastName": "Petrov",
- "carModel": "Lamborghini",
- "carNumber": "A456BC123",
- "officeName": "Koledino",
- "officeAddress": "Kosmonavtov 10А",
- "officeId": 15,
- "id": 1
}
]
Create pass{{ /api/v3/passes }}
Creates a supplier pass.
The pass is valid for 48 hours from the time of creation.
Authorizations:
Request Body schema: application/jsonrequired
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
- Payload
{- "firstName": "Alex",
- "lastName": "Petrov",
- "carModel": "Lamborghini",
- "carNumber": "A456BC123",
- "officeId": 15
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 429
{- "id": 2
}
Update pass{{ /api/v3/passes/{passId} }}
Updates the seller's pass detail
Authorizations:
path Parameters
passId required | integer <int64> Example: 45 Pass ID |
Request Body schema: application/jsonrequired
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
- Payload
{- "firstName": "Alex",
- "lastName": "Petrov",
- "carModel": "Lamborghini",
- "carNumber": "A456BC123",
- "officeId": 15
}
Response samples
- 400
- 401
- 403
- 404
- 429
{- "code": "IncorrectRequestBody",
- "message": "Incorrect request body"
}
Delete the pass{{ /api/v3/passes/{passId} }}
Deletes the seller's pass
Authorizations:
path Parameters
passId required | integer <int64> Example: 45 Pass ID |
Responses
Response samples
- 401
- 403
- 404
- 429
{- "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"
}
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
Other methods — a maximum of 300 requests per minute in total.
Get new orders{{ /api/v3/orders/new }}
Returns a list of all new orders
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": "Упакуйте в плёнку, пожалуйста",
- "scanPrice": null,
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "offices": [
- "Калуга"
], - "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "nmId": 123456789,
- "chrtId": 987654321,
- "price": 1014,
- "convertedPrice": 28322,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "isZeroOrder": false
}
]
}
Get orders{{ /api/v3/orders }}
Returns orders information without current status.
It is possible to export data for a specific period, maximum 30 calendar days
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 | 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 samples
- 200
- 400
- 401
- 403
- 429
{- "next": 13833711,
- "orders": [
- {
- "address": {
- "fullAddress": "Chelyabinsk Region, Chelyabinsk, 51st Arabkir Street, Building 10A, Apartment 42",
- "longitude": 44.519068,
- "latitude": 40.20192
}, - "scanPrice": 1500,
- "deliveryType": "dbs",
- "supplyId": "WB-GI-92937123",
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "offices": [
- "Kaluga"
], - "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "nmId": 12345678,
- "chrtId": 987654321,
- "price": 1014,
- "convertedPrice": 28322,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "comment": "Упакуйте в плёнку, пожалуйста",
- "isZeroOrder": false
}
]
}
Get orders statuses{{ /api/v3/orders/status }}
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 of supplierStatus
:
Status | Description | How to move the order to this status |
---|---|---|
new | New order | |
confirm | In assembly For delivery by Wildberries fbs and by the seller dbs |
For fbs — add order to the supply For dbs — transfer order to assembly |
complete | In delivery For delivery by Wildberries fbs and by WB courier wbgo |
For fbs — transfer the supply to delivery For wbgo — transfer the order to delivery |
cancel | Canceled by seller | Cancel the order |
cancel_missed_call | Order cancellation due to missed call. For delivery by the seller dbs |
Status changes automatically |
deliver | In delivery For delivery by the seller dbs |
Transfer the order to delivery |
receive | Received by the buyer For delivery by the seller dbs and by WB courier wbgo |
For dbs — report that the order has been accepted by the buyer For wbgo the status changes automatically |
reject | Buyer rejection upon receipt For delivery by the seller dbs and by WB courier wbgo |
For dbs — report that the buyer refused the order For wbgo 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 yetsorted
— the Wildberries warehouse sorted the ordersold
— the order is soldcanceled
— the supplier canceled the ordercanceled_by_client
— the buyer canceled the order upon receiptdeclined_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 defectready_for_pickup
— the order came at pickup point and waiting the clientcanceled_by_missed_call
— order cancellation due to unreachable customer. For Delivery by Supplierdbs
postponed_delivery
— courier delivery is postponed
Authorizations:
Request Body schema: application/json
orders required | Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ] Order IDs |
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/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"
}
Add Data Matrix code to the order{{ /api/v3/orders/{orderId}/meta/sgtin }}
The method allows attaching a Data Matrix code Chestny ZNAK to an order.
Attaching a Data Matrix code to an order is only possible if this field is returned in the response of the method to get the metadata of the order, and the order is in the confirm status.
The loaded Data Matrix code can be retrieved through the method to get the metadata of 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. |
Responses
Request samples
- Payload
{- "sgtins": [
- "1234567890123456"
]
}
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Incorrect request body"
}
Get orders stickers{{ /api/v3/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
- 580x400 px, with parameters
Authorizations:
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
Request samples
- Payload
{- "orders": [
- 5346346
]
}
Response samples
- 200
- 400
- 401
- 403
- 429
{- "stickers": [
- {
- "orderId": 5346346,
- "partA": 231648,
- "partB": 9753,
- "barcode": "!uKEtQZVx",
- "file": "PD94bWwgdmVyc2lvbj0iMS4wIj8+CjwhLS0gR2VuZXJhdGVkIGJ5IFNWR28gLS0+Cjxzdmcgd2lkdGg9IjQwMCIgaGVpZ2h0PSIzMDAiCiAgICAgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIgogICAgIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIj4KPHJlY3QgeD0iMCIgeT0iMCIgd2lkdGg9IjQwMCIgaGVpZQiIGhlaWdodD0iMTcwIiBzdHlsZT0iZmlsbDpibGFjayIgLz4KPHJlY3QgeD0iMzE4IiB5PSIyMCIgd2lkdGg9IjYiIGhlaWdodD0iMTcwIiBzdHlsZT0iZmlsbDpibGFjayIgLz4KPHJlY3QgeD0iMzI2IiB5PSIyMCIgd2lkdGg9IjIiIGhlaWdodD0iMTcwIiBzdHlsZT0iZmlsbDpibGFjayIgLz4KPHJlY3QgeD0iMzMwIiB5PSIyMCIgd2lkdGg9IjQiIGhlaWdodD0iMTcwIiBzdHlsZT0iZmlsbDpibGFjayIgLz4KPHJlY3QgeD0iMjAiIHk9IjIwMCIgd2lkdGg9IjM1MCIgaGVpZ2h0PSI5MCIgc3R5bGU9ImZpbGw6YmxhY2siIC8+Cjx0ZXh0IHg9IjMwIiB5PSIyNDAiIHN0eWxlPSJmaWxsOndoaXRlO2ZvbnQtc2l6ZTozMHB0O3RleHQtYW5jaG9yOnN0YXJ0IiA+MjMxNjQ4PC90ZXh0Pgo8dGV4dCB4PSIzNTAiIHk9IjI3MCIgc3R5bGU9ImZpbGw6d2hpdGU7Zm9udC1zaXplOjUwcHQ7dGV4dC1hbmNob3I6ZW5kIiA+OTc1MzwvdGV4dD4KPC9zdmc+Cg=="
}
]
}
Get order metadata{{ /api/v3/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": 123456789012345,
- "uin": 1234567890123456,
- "gtin": 1234567890123,
- "sgtin": 1234567890123456
}
}
Delete order metadata{{ /api/v3/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 the metadata to remove (imei, uin, gtin) |
Responses
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectRequest",
- "message": "Incorrect request parameters"
}
Add UIN (unique identification number) to the order{{ /api/v3/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.
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/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.
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/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.
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"
}
Get a list of links to stickers that are required for cross-bordering{{ /api/v3/files/orders/external-stickers }}
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:
Request Body schema: application/json
orders | Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ] Order IDs |
Responses
Request samples
- Payload
{- "orders": [
- 5346346
]
}
Response samples
- 200
- 400
- 401
- 403
- 429
{
}
Status history for cross-border orders{{ /api/v3/orders/status/history }}
Returns status history for cross-border orders
Authorizations:
Request Body schema: application/json
orders | Array of integers [ 1 .. 100 ] items Orders IDs |
Responses
Request samples
- Payload
{- "orders": [
- 123456789,
- 987654321
]
}
Response samples
- 200
- 401
- 403
- 404
- 429
{- "orders": [
- {
- "deliveryDate": "string",
- "statuses": [
- {
- "date": null,
- "code": "SORTED"
}
], - "orderID": 123456789
}
]
}
Orders with client information{{ /api/v3/orders/client }}
The method allows getting information about the client by order ID.
Only for cross-border orders from Turkey
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
}
]
}
- Create a new supply. The ID of the created supply will be returned in the format WB-GI-1234567.
- In the current new supply, add Orders that you will transport to the warehouse or pickup point. When adding Orders to the supply, they will be moved to the confirm status — in assembly.
- Create a box in the supply
- Add orders to the box
- Check the list of boxes with orders
- Get the box stickers, print them out and affix the stickers to the boxes according to the orders distributed in them.
- You can remove a box from the supply, but only while the supply is still in assembly.
- You can remove orders from the box, but only while the supply is still in assembly.
- After the supply has been equipped with the necessary Orders, it must be handed over for delivery. If the supply is not handed over for delivery, scanning its barcode or accepting the first product at the pickup point will automatically close the supply. When handing over Orders for delivery, they will automatically be assembled and moved to the complete status — in delivery.
- You can get a list of all Orders added to the supply.
- You can get information about all the seller's supplies or about a specific supply.
- You can delete a supply provided that it is active and not tied to any Orders.
- If a supply was scanned at the acceptance point but still has unscanned products, after a certain time, you must deliver them again. Check all Orders requiring reshipment at this time. These Orders can be transferred to another active supply. The order will also be moved to the confirm status — in assembly.
- You can also move Orders between active supplies. You cannot move an order from a supply that is already closed, unless it requires reshipment.
- You can get the supply's QR code in SVG, ZPL, or PNG formats. Available only after the supply has been handed over for delivery.
Create a new supply{{ /api/v3/supplies }}
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:
Request Body schema: application/jsonrequired
name | string [ 1 .. 128 ] characters Supply name |
Responses
Request samples
- Payload
{- "name": "Some test supply"
}
Response samples
- 201
- 400
- 401
- 403
- 429
{- "id": "WB-GI-1234567"
}
Get a supplies list{{ /api/v3/supplies }}
Returns the supply list.
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 |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
{- "next": 13833711,
- "supplies": [
- {
- "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
}
]
}
Add the order to the supply{{ /api/v3/supplies/{supplyId}/orders/{orderId} }}
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.
cargoType
field in the field.After that, you can only add tasks of the same dimensional type as the supply.
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 Supply ID |
orderId required | integer <int64> Example: 5632423 Order ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}
Get supply details{{ /api/v3/supplies/{supplyId} }}
Returns supply details.
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 Supply ID |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "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{{ /api/v3/supplies/{supplyId} }}
Deleted the supply if it is active and does not contain any orders.
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 Supply ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}
Get the supply orders{{ /api/v3/supplies/{supplyId}/orders }}
Returns orders assigned to the supply.
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 Supply ID |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "orders": [
- {
- "scanPrice": null,
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "offices": [
- "Калуга"
], - "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "nmId": 123456789,
- "chrtId": 987654321,
- "price": 1014,
- "convertedPrice": 28322,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "isZeroOrder": false
}
]
}
Move the supply to the delivery{{ /api/v3/supplies/{supplyId}/deliver }}
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:
path Parameters
supplyId required | string Example: WB-GI-1234567 Supply ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}
Get the supply QR code{{ /api/v3/supplies/{supplyId}/barcode }}
Returns the QR code in svg, zplv (vertical), zplh (horizontal), png.
Available only after the supply has been transferred to the delivery.
Available dimensions:
Authorizations:
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 samples
- 200
- 400
- 401
- 403
- 404
- 409
- 429
{- "barcode": "WB-GI-12345678",
- "file": "U3dhZ2dlciByb2Nrcw=="
}
Get supply boxes list{{ /api/v3/supplies/{supplyId}/trbx }}
Returns supply boxes list with assigned orders
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 Supply ID |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "trbxes": [
- {
- "id": "WB-TRBX-1234567",
- "orders": [
- 1234567
]
}
]
}
Add boxes to the supply{{ /api/v3/supplies/{supplyId}/trbx }}
Adds the required number of boxes to the supply. Available only while the supply is being assembled
Authorizations:
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
Request samples
- Payload
{- "amount": 4
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 429
{- "trbxIds": [
- "WB-TRBX-1234567"
]
}
Delete boxes from the supply{{ /api/v3/supplies/{supplyId}/trbx }}
Removes orders from the listed delivery boxes and deletes the boxes. Available only while the supply is being assembled
Authorizations:
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
- Payload
{- "trbxIds": [
- "WB-TRBX-1234567"
]
}
Response samples
- 400
- 401
- 403
- 404
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}
Add orders to the box{{ /api/v3/supplies/{supplyId}/trbx/{trbxId} }}
Add orders to the supply box. Available only while the supply is being assembled.
Authorizations:
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
- Payload
{- "orderIds": [
- 1234567
]
}
Response samples
- 400
- 401
- 403
- 404
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}
Delete order from the box{{ /api/v3/supplies/{supplyId}/trbx/{trbxId}/orders/{orderId} }}
Deletes order from the supply box. Available only while the supply is being assembled
Authorizations:
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
- 400
- 401
- 403
- 404
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}
Get the supply box QR code stickers{{ /api/v3/supplies/{supplyId}/trbx/stickers }}
Returns QR-code stickers in svg, zplv (vertical), zplh (horizontal), png.
Available only if there are orders in the box.
Authorizations:
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
Request samples
- Payload
{- "trbxIds": [
- "WB-TRBX-1234567"
]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "stickers": [
- {
- "barcode": "$WBMP:1:123:1234567",
- "file": "U3dhZ2dlciByb2Nrcw=="
}
]
}
How to work:
- Receive a new order
- Transfer it for assembly
- Transfer to delivery
- After the order is transferred to assembly, client information (name, phone) becomes available.
- After delivering the task to the client, you need to notify our server that the order was accepted by the client or that the client declined the order.
Transfer to assembly{{ /api/v3/orders/{orderId}/confirm }}
Transfers the order to the status confirm (On assembly
)
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 delivery{{ /api/v3/orders/{orderId}/deliver }}
Transfers the order to the status deliver (In delivery
)
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"
}
Notify that the order has been accepted by the client{{ /api/v3/orders/{orderId}/receive }}
Transfers the order to the status receive (Received by the client
)
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 Order ID |
Request Body schema: application/jsonrequired
code | string Client delivery code |
Responses
Request samples
- Payload
{- "code": "string"
}
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}
Notify that the client has declined the order{{ /api/v3/orders/{orderId}/reject }}
Transfers to the status reject (Declined upon receipt
)
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 Order ID |
Request Body schema: application/jsonrequired
code | string Client delivery code |
Responses
Request samples
- Payload
{- "code": "string"
}
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}
How to work:
- Receive a new order with
"deliveryType": "wbgo"
- Transfer it for assembly
- Get and print order stickers
- Transfer to delivery
- Waiting for the courier
- The courier picks up the order and delivers it to the customer
- The customer accepts or declines the order
- If the customer accepts the order, the task is automatically set to the status
receive
. If declined, it sets toreject
Transfer to assembly{{ /api/v3/orders/{orderId}/confirm }}
Transfers the order to the status confirm (On assembly
)
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 delivery{{ /api/v3/orders/{orderId}/assemble }}
Transfers order to the status complete
— in delivery
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"
}
Contacts list{{ /api/v3/warehouses/{warehouseId}/contacts }}
Returns a list of contacts linked to the seller's warehouse
Authorizations:
path Parameters
warehouseId required | integer <int64> Example: 1 Warehouse ID |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
[- {
- "contacts": [
- {
- "comment": "Иванов Иван Иванович. Звонить с 10 до 21 часа.",
- "phone": "+79998887766"
}
]
}
]
Update contacts list{{ /api/v3/warehouses/{warehouseId}/contacts }}
Updates the seller's warehouse contact list.
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:
path Parameters
warehouseId required | integer <int64> Example: 1 Warehouse ID |
Request Body schema: application/jsonrequired
Array of objects <= 5 items |
Responses
Request samples
- Payload
{- "contacts": [
- {
- "comment": "Иванов Иван Иванович. Звонить с 10 до 21 часа.",
- "phone": "+79998887766"
}
]
}
Response samples
- 400
- 401
- 403
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter value"
}