Search
API docs by Redocly

FBS Orders (order)

Management of Orders, deliveries, warehouses, and passes

Methods for working with assembly orders of the DBW model (Delivery by Wildberries) are now in a separate environment.

FBS Orders

Management of Orders, deliveries, warehouses, and passes

Methods for working with assembly orders of the DBW model (Delivery by Wildberries) are now in a separate environment.

FBS Assembly Orders

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

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

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

Returns a list of all new assembly orders

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

Authorizations:
HeaderApiKey

Responses

Response samples

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

Get assembly orders{{ /api/v3/orders }}

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

Returns assembly orders information without current status.
You can get data for a specified period, maximum of 30 calendar days per request.

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 5 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
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 assembly orders statuses{{ /api/v3/orders/status }}

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

Returns the statuses of assembly orders from the request.

supplierStatus is a status of an assembly order. Its change is always triggered only by the supplier.

Possible values of supplierStatus:

Status Description How to move the assembly orders to this status
new New order
confirm In assembly
For delivery by Wildberries fbs		 Add assembly orders to the supply
complete In delivery
For delivery by Wildberries fbs and by WB courier wbgo		 For fbs — transfer the supply to delivery
For wbgo — transfer the assembly orders to delivery
cancel Canceled by seller Cancel the order
receive Received by the buyer
For WB courier wbgo		 The status changes automatically
reject Buyer rejection upon receipt
For WB courier 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 assembly orders came at pickup point and waiting for the client
  • postponed_delivery — courier delivery is postponed
Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

List of assembly order IDs

Responses

Request samples

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

Response samples

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

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

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

Returns all assembly orders that require re-shipment

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

Authorizations:
HeaderApiKey

Responses

Response samples

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

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

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

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

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

Assembly order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

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

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

Returns a list of stickers according to the requested assembly orders. You can request a sticker in svg, zplv (vertical), zplh (horizontal) and png formats.

Method limitations:

  • You cannot request more than 100 stickers at a time (no more than 100 assembly orders IDs in a request).
  • The method returns stickers only for assembly 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
Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

Authorizations:
HeaderApiKey
query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Sticker format

width
required
integer
Enum: 58 40

Sticker width

height
required
integer
Enum: 40 30

Sticker height

Request Body schema: application/json
orders
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ]

List of assembly order IDs

Responses

Request samples

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

Response samples

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

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 assembly order IDs in a request).
  • The method returns stickers only for assembly orders that are in delivery (in complete status).
Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

List of assembly 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

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

Assembly 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 assembly order ID.
Only for cross-border orders from Turkey

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

FBS Metadata

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

With these methods, you can get, delete and edit the metadata of assembly orders:

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

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

Returns assembly order metadata.

Possible metadata are:

If any of the metadata objects are not returned in the response, it means that the assembly order cannot have such metadata, and they cannot be added

Requests limit per one seller's account for all methods for getting and deleting FBS metadata:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

Assembly order ID

Responses

Response samples

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

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

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

Removes all assembly order metadata values for the passed key.

Possible metadata are:

Requests limit per one seller's account for all methods for getting and deleting FBS metadata:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

Assembly order ID

query Parameters
key
string

Name of the metadata to remove (imei, uin, gtin, sgtin)

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Incorrect request parameters"
}

Add Data Matrix code to the assembly order{{ /api/v3/orders/{orderId}/meta/sgtin }}

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

The method allows attaching a Data Matrix code Chestny ZNAK to an assembly order.

Attaching a Data Matrix code to an assembly order is only possible if this field is returned in the response of the method to get the metadata of the order, and the assembly order is in the confirm status.

The loaded Data Matrix code can be retrieved through the method to get the metadata of the order

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

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

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

Assembly order ID

Request Body schema: application/json
sgtins
Array of strings [ 1 .. 24 ] items

List of Data Matrix codes.

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "message": "Incorrect request body"
}

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

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

Sets the UIN for the assembly order. The assembly order can only have one UIN. You can add the code only for assembly orders in the confirm status.

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

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

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

Assembly order ID

Request Body schema: application/json
uin
required
string = 16 characters

UIN

Responses

Request samples

Content type
application/json
{
  • "uin": "1234567890123456"
}

Response samples

Content type
application/json
Example
{
  • "message": "Incorrect request body"
}

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

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

Sets the IMEI for the assembly order.

The assembly order can have only one IMEI. If a device has two IMEIs — IMEI and IMEI2 or IMEI1 and IMEI2 — you should only specify IMEI or IMEI1. You don't need to specify IMEI2.

You can add the code only for assembly orders in the confirm status.

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

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

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

Assembly order ID

Request Body schema: application/json
imei
required
string = 15 characters

IMEI

Responses

Request samples

Content type
application/json
{
  • "imei": "123456789012345"
}

Response samples

Content type
application/json
Example
{
  • "message": "Incorrect request body"
}

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

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

Sets the GTIN (Belarus product unique identifier) for the assembly order. The assembly order can only have one GTIN. You can add the code only for assembly orders in the confirm status.

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

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

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

Assembly order ID

Request Body schema: application/json
gtin
required
string = 13 characters

GTIN

Responses

Request samples

Content type
application/json
{
  • "gtin": "1234567890123"
}

Response samples

Content type
application/json
Example
{
  • "message": "Incorrect request body"
}

Add expiration date to the assembly order{{ /api/v3/orders/{orderId}/meta/expiration }}

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

Sets the expiration date for the assembly order.
The expiration date can only be added for assembly orders that are delivered by WB and are in the confirm status.

You can get the uploaded data in the metadata of the assembly order.
To change the expiration date, send a request with the new date. It is impossible to remove the expiration date from the metadata of the assembly order.

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

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

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

Assembly order ID

Request Body schema: application/json
expiration
string <date (dd.mm.yyyy)>

The date until which the product is valid. No less than 30 days from the current date.

Responses

Request samples

Content type
application/json
{
  • "expiration": "12.09.2030"
}

Response samples

Content type
application/json
Example

The specified expiration date is less than the allowable limit

{
  • "code": "LowExpirationDate",
  • "message": "Не удалось обновить срок годности. Указан срок меньше допустимого"
}

FBS Supplies

To access the methods, use a token for the Marketplace category
Work order:
Items 3-5 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 assembly orders that you will transport to the warehouse or pickup point. When adding assembly order to the supply, they will be moved to the confirm status — in assembly.
  3. Create a box in the supply
  4. Check the list of boxes
  5. Get the box stickers, print them out and affix the stickers to the boxes according to the orders distributed in them.
  6. After the supply has been equipped with the necessary assembly orders, it must be handed over for delivery. If the supply is not handed over for delivery, accepting the first product at the pickup point will automatically close the supply. When handing over assembly order for delivery, they will automatically be assembled and moved to the complete status — in delivery.
  7. 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 assembly order requiring reshipment at this time. These assembly order can be transferred to another active supply. The assembly order will also be moved to the confirm status — in assembly.

You can also:

  1. Remove a box from the supply, but only while the supply is still in assembly.
  2. Get a list of all assembly order added to the supply.
  3. Get information about all the seller's supplies or about a specific supply.
  4. Delete a supply provided that it is active and not tied to any assembly orders.
  5. Move assembly orders between active supplies. You cannot move an assembly order from a supply that is already closed, unless it requires reshipment.
  6. 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 assembly orders in the FBS (Fulfillment by Seller) delivery.
  • All assembly 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 assembly order is added to a supply, the supply acquires the dimensional attribute of that assembly order.
Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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.

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

One request with a response code of 409 is counted as 5 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.

Responses

Response samples

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

Add the assembly order to the supply{{ /api/v3/supplies/{supplyId}/orders/{orderId} }}

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

Adds an assembly order to a supply and moves it to confirm status.
It can also move the assembly order between active supplies. Or from a closed to an active supply, if the assembly order requires reshipment.

You can add an assembly 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.
Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 1000 requests 60 milliseconds 20 requests

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

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

orderId
required
integer <int64>
Example: 5632423

Assembly order ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Get supply details{{ /api/v3/supplies/{supplyId} }}

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

Returns supply details.

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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,
  • "destinationOfficeId": 123
}

Delete the supply{{ /api/v3/supplies/{supplyId} }}

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

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

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Get the supply orders{{ /api/v3/supplies/{supplyId}/orders }}

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

Returns assembly orders assigned to the supply.

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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 assembly orders to complete (In Delivery) status. You cannot add any assembly orders to the supply after it is closed.

If the supply wasn't handed over for delivery, than scanning its QR code or accepting the first product will automatically close the supply.

You can transfer the supply to delivery only if it contains at least one assembly order and no empty boxes.

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

Supply ID

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

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
Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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.

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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.

Boxes should only be added to deliveries shipped to the pickup points. Available only while the supply is being assembled

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

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

The method deletes boxes from the supply. Available only while the supply is being assembled.

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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": "Передан некорректный параметр"
}

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 assembly orders in the box.

Stickers dimensions: 580x400 px
Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

FBS 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.

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Returns a list of all seller's passes.

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

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
{
  • "message": "Incorrect request body"
}

Delete the pass{{ /api/v3/passes/{passId} }}

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

Deletes the seller's pass

Requests limit per one seller's account for all FBS assembly orders, supplies and passes methods:
Period Limit Interval Burst
1 minute 300 requests 200 milliseconds 20 requests

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

Authorizations:
HeaderApiKey
path Parameters
passId
required
integer <int64>
Example: 45

Pass ID

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "detail": "string",
  • "code": "string",
  • "requestId": "string",
  • "origin": "string",
  • "status": 0,
  • "statusText": "string",
  • "timestamp": "string"
}