Search
API docs by Redocly

FBS Orders (order)

Management of Orders, deliveries, warehouses, and passes

FBS Orders

Management of Orders, deliveries, warehouses, and passes

Orders

To access the methods, use a token for the Marketplace category
Starting from February 13, working with orders of the DBS scheme will only be possible via designated URLs.

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

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

Returns a list of all new orders

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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 samples

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

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 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 client
  • canceled_by_missed_call — order cancellation due to unreachable customer. For Delivery by Supplier dbs
  • postponed_delivery — courier delivery is postponed
Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

Order IDs

Responses

Request samples

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

Response samples

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

Get all orders for re-shipment{{ /api/v3/supplies/orders/reshipment }}

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

Returns all orders that require re-shipment

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

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

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

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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{{ /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

Maximum of 1 000 requests per minute in total per one seller's account:
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:
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{{ /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
Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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

Request samples

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

Response samples

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

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.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

Order ID

Responses

Response samples

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

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

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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{{ /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.

Maximum of 1 000 requests per minute in total per one seller's account:
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:
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{{ /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.

Maximum of 1 000 requests per minute in total per one seller's account:
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:
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{{ /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.

Maximum of 1 000 requests per minute in total per one seller's account:
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:
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{{ /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).
Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ]

Order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{}

Status history for cross-border orders{{ /api/v3/orders/status/history }}

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

Returns status history for cross-border orders

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
Array of integers [ 1 .. 100 ] items

Orders IDs

Responses

Request samples

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

Response samples

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Orders list

Responses

Request samples

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

Response samples

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

FBS Supplies

To access the methods, use a token for the Marketplace category
Work order:
Items 3-8 must be completed when delivering a supply to a pickup point
  1. Create a new supply. The ID of the created supply will be returned in the format WB-GI-1234567.
  2. 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.
  3. Create a box in the supply
  4. Add orders to the box
  5. Check the list of boxes with orders
  6. Get the box stickers, print them out and affix the stickers to the boxes according to the orders distributed in them.
  7. You can remove a box from the supply, but only while the supply is still in assembly.
  8. You can remove orders from the box, but only while the supply is still in assembly.
  9. 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.
  10. You can get a list of all Orders added to the supply.
  11. You can get information about all the seller's supplies or about a specific supply.
  12. You can delete a supply provided that it is active and not tied to any Orders.
  13. 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.
  14. You can also move Orders between active supplies. You cannot move an order from a supply that is already closed, unless it requires reshipment.
  15. 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.
Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
name
string [ 1 .. 128 ] characters

Supply name

Responses

Request samples

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

Response samples

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

Get a supplies list{{ /api/v3/supplies }}

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

Returns the supply list.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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 samples

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

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.

You can add an order of any dimensional type to an empty supply. After adding the first task, the supply acquires the dimensional type of this task from the cargoType field in the field.
After that, you can only add tasks of the same dimensional type as the supply.
Maximum of 1 000 requests per minute per one seller's account
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{{ /api/v3/supplies/{supplyId} }}

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

Returns supply details.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

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{{ /api/v3/supplies/{supplyId} }}

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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{{ /api/v3/supplies/{supplyId}/orders }}

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

Returns orders assigned to the supply.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

Response samples

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

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.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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{{ /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:

580x400 px
Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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 samples

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

Get supply boxes list{{ /api/v3/supplies/{supplyId}/trbx }}

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

Returns supply boxes list with assigned orders

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

Response samples

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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

Request samples

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

Response samples

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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{{ /api/v3/supplies/{supplyId}/trbx/{trbxId} }}

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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{{ /api/v3/supplies/{supplyId}/trbx/{trbxId}/orders/{orderId} }}

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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{{ /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.

Stickers dimensions: 580x400 px
Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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

Request samples

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

Response samples

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

Passes

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

Get offices for pass{{ /api/v3/passes/offices }}

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

Returns a list of offices that require a pass.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get passes{{ /api/v3/passes }}

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

Returns a list of all seller's passes.

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create pass{{ /api/v3/passes }}

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

Creates a supplier pass.
The pass is valid for 48 hours from the time of creation.

Maximum of 1 request per 10 minutes per one seller's account
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

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{{ /api/v3/passes/{passId} }}

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

Updates the seller's pass detail

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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{{ /api/v3/passes/{passId} }}

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

Deletes the seller's pass

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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 (DBW)

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

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

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

Transfers the order to the status confirm (On assembly)

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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 delivery{{ /api/v3/orders/{orderId}/assemble }}

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

Transfers order to the status complete — in delivery

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
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{{ /api/v3/warehouses/{warehouseId}/contacts }}

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

Warehouse ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update contacts list{{ /api/v3/warehouses/{warehouseId}/contacts }}

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

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

Maximum of 300 requests per minute for all methods in the Marketplace category per one seller's account
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

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"
}