Search
API docs by Redocly

FBS Orders (order)

Use the FBS Orders (Fulfillment by Seller) methods to:

  • get information about assembly orders and their statuses, cancel assembly orders, and get stickers
  • get, add, edit, and delete label identifiers for assembly orders
  • manage supplies
  • create, edit, and delete passes to WB warehouses

You can test the FBS order methods in the sandbox. Also you can use special methods in the sandbox for emulating user actions

FBS Orders

Use the FBS Orders (Fulfillment by Seller) methods to:

  • get information about assembly orders and their statuses, cancel assembly orders, and get stickers
  • get, add, edit, and delete label identifiers for assembly orders
  • manage supplies
  • create, edit, and delete passes to WB warehouses

You can test the FBS order methods in the sandbox. Also you can use special methods in the sandbox for emulating user actions

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.

Label identifiers specified in the requiredMeta and optionalMeta fields in assembly orders only affects the ability to transfer a supply to delivery. If your item requires mandatory marking with identification means, you must specify all needed label identifiers whether it was received in requiredMeta or optionalMeta field (see 4.6 of the Offer).
We recommend adding all label identifiers received in the requiredMeta and optionalMeta fields to the assembly orders
Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

Authorizations:
HeaderApiKey

Responses

Response samples

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

Get Assembly Orders{{ /api/v3/orders }}

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

The method returns information about assembly orders created no more than 3 months ago, without their current status
To get data for a period, specify the start and end dates of the period in the request. Maximum of 30 calendar days per request. The method's response will contain assembly orders created during the specified period.

To get assembly orders created more than 3 months ago, use the method for getting the list of archived assembly orders.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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. Time zone — UTC

dateTo
integer

Period end date in Unix timestamp format. Time zone — UTC

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

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		 Transfer the supply to delivery
cancel Canceled by seller Cancel the order
cancel_carrier Canceled by carrier
For crossborder only		 Changed by the carrier

wbStatus — is a status of an order on the Wildberries side.

Possible values for this field are:

  • waiting — the seller 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 seller 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 for the client
  • postponed_delivery — courier delivery is postponed
  • accepted_by_carrier — accepted by carrier. The order is handed over to delivery service in the seller country
  • sent_to_carrier — dispatched to carrier. The order is on the way to delivery service's warehouse in the seller
  • canceled_by_carrier — the order was cancelled by the carrier. For crossborder only
Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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 seller") status.

You can cancel an assembly order before it is handed over to Wildberries. To check whether an assembly order can be canceled, use the POST /api/v3/orders/status method and the isCancellable field.
Request limit per one seller account:
Period Limit Interval Burst
1 min 100 requests 600 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Assembly order ID

Responses

Response samples

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

Get Assembly Orders Stickers{{ /api/v3/orders/stickers }}

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

Returns a list of stickers for assembly orders in the confirm — in assembly and complete — in delivery statuses.

If the required customs declaration number is not added to the assembly order, it is not possible to get stickers for this assembly order.

You can get a maximum of 100 stickers per request.

You can get a sticker in the following formats:

  • SVG
  • ZPLV (vertical)
  • ZPLH (horizontal)
  • PNG

Available dimensions:

  • 580x400 px, with parameters width = 58, height = 40
  • 400x300 px, with parameters width = 40, height = 30
Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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 Stickers for Cross-Border Assembly Orders{{ /api/v3/orders/stickers/cross-border }}

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

Returns a list of stickers for Cross-Border assembly orders in PDF.

For each assembly order, the response contains the sticker generation status:

  • awaitingTrackNumber — the sticker is not ready. Waiting for a carrier's track number.
  • ready — the sticker is ready
Stickers may be generated with a delay. Repeat the request until you receive the ready status.

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 on assembly or in delivery status: confirm, complete.

In the sandbox, this method always returns the 200 response.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 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
{
  • "stickers": [
    ]
}

Status History for Cross-Border Orders{{ /api/v3/orders/status/history }}

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

Returns status history for Cross-Border orders.

In the sandbox, this method always returns the 200 response.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Get the List of Archived Assembly Orders{{ /api/marketplace/v3/fbs/orders/archive }}

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

The method returns assembly orders created more than 3 months ago.
Some assembly orders are archived later than 3 months after creation, as the supply is archived only after all orders in it are completed. For example, this happens if the seller did not deliver one of the orders in the supply and the order was canceled automatically after a few days.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests

Authorizations:
HeaderApiKey
query Parameters
year
required
integer
Example: year=2023

Year the order was created

month
required
integer [ 1 .. 12 ]
Example: month=2

Month the order was created

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.

limit
required
integer <int32> [ 100 .. 1000 ]
Example: limit=150

Number of assembly orders in the response

Responses

Response samples

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

FBS Label Identifiers

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

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

Specifying label identifiers for the assembly order in the sandbox is optional

Get Assembly Orders Label Identifiers{{ /api/marketplace/v3/orders/meta }}

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

The method returns label identifiers for assembly orders and their validation statuses.

You can get the list of label identifiers available for an assembly order in the requiredMeta and optionalMeta fields in the response of the Get New Assembly Orders method. If the requiredMeta and optionalMeta fields do not contain the label identifier, it means that this label identifier cannot be added to this assembly order.
Possible label identifiers:

Request limit per one seller account for all methods for getting and deleting FBS label identifiers:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
required
Array of integers <= 100 items

Responses

Request samples

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

Response samples

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

Delete Assembly Order Label Identifiers{{ /api/v3/orders/{orderId}/meta }}

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

Removes all assembly order label identifiers values for the passed key.

Possible label identifiers are:

Request limit per one seller account for all methods for getting and deleting FBS label identifiers:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Assembly order ID

query Parameters
key
required
string
Enum: "imei" "uin" "gtin" "sgtin" "customsDeclaration"

Name of the label identifier to remove

Responses

Response samples

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

Add Labeling Code Chestny ZNAK to the Assembly Order{{ /api/v3/orders/{orderId}/meta/sgtin }}

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

The method sets the labeling code Chestny ZNAK for the assembly order.
You can add a labeling code to an assembly order if this field is returned in the response of the Assembly Order Label Identifiers method, and the assembly order is in the confirm status.

You can get the added labeling code with the Assembly Order Label Identifiers method.

Request limit per one seller account for all methods for adding FBS label identifiers:
Period Limit Interval Burst
1 min 1000 requests 60 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Assembly order ID

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

List of labeling codes Chestny ZNAK.
You can transfer labeling codes:

  • in full format — with GS separators and authenticity verification code (crypto tail)
  • in short format — with GS separators without authenticity verification code (crypto tail)

Please transfer GS separators in Unicode encoding with escaping — \u001D

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 UIN to the assembly order only if the uin field is returned in the response of the Assembly Order Label Identifiers method, and the assembly order is in the confirm status.

Request limit per one seller account for all methods for adding FBS label identifiers:
Period Limit Interval Burst
1 min 1000 requests 60 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Assembly order ID

Request Body schema: application/json
required
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 orders label identifiers.
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 IMEI to the assembly order only if the imei field is returned in the response of the Assembly Order Label Identifiers method, and the assembly order is in the confirm status.

Request limit per one seller account for all methods for adding FBS label identifiers:
Period Limit Interval Burst
1 min 1000 requests 60 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Assembly order ID

Request Body schema: application/json
required
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 item unique identifier) for the assembly order. The assembly order can only have one GTIN.
You can add GTIN to the assembly order only if the gtin field is returned in the response of the Assembly Order Label Identifiers method, and the assembly order is in the confirm status.

Request limit per one seller account for all methods for adding FBS label identifiers:
Period Limit Interval Burst
1 min 1000 requests 60 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Assembly order ID

Request Body schema: application/json
required
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.
You can add expiration date to the assembly order only if the expiration field is returned in the response of the Assembly Order Label Identifiers method, and the assembly order is in the confirm status.

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

Request limit per one seller account for all methods for adding FBS label identifiers:
Period Limit Interval Burst
1 min 1000 requests 60 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Assembly order ID

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

The date until which the item 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": "Не удалось обновить срок годности. Указан срок меньше допустимого"
}

Add Custom Declaration number to the Order{{ /api/marketplace/v3/orders/{orderId}/meta/customs-declaration }}

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

The method updates the customs declaration number in the label identifiers of the assembly order. An assembly order can have only one customs declaration number.
You can add customs declaration number to the assembly order only if the customsDeclaration field is returned in the response of the Assembly Order Label Identifiers method, and the assembly order is in the confirm status.

Sellers from Armenia must specify the customs declaration number for items produced outside the EAEU if an order from Armenia is delivered to the Russian Federation.
Request limit per one seller account for all methods for adding FBS label identifiers:
Period Limit Interval Burst
1 min 1000 requests 60 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Assembly order ID

Request Body schema: application/json
required
customsDeclaration
required
string [ 17 .. 29 ] characters

Customs declaration number

Responses

Request samples

Content type
application/json
{
  • "customsDeclaration": "10704010/010624/0000302"
}

Response samples

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

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. Set up the supply shipping method. For delivery by a transport company the electronic waybill ID is required.

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

  4. Create a shipping unit in the supply.

  5. Check the list of shipping units.

  6. Get the shipping unit stickers, print them out and affix the stickers to the shipping units according to the orders distributed in them.

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

  8. If a supply was scanned at the acceptance point but still has unscanned items, 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:

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.
Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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 supplies list.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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 Assembly Orders to the Supply{{ /api/marketplace/v3/supplies/{supplyId}/orders }}

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

The method adds up to 100 assembly orders to the supply and moves it to the confirm status.

It can also move the assembly orders:

  • between active supplies
  • from a closed to an active supply, if the assembly order requires reshipment.
You can add assembly orders of any dimensional type to an empty supply. After adding the first assembly order, the supply acquires the dimensional type of this assembly order from the cargoType field.
After that, you can only add assembly orders of the same dimensional type as the supply.
Assembly orders received at different warehouses cannot be added to the delivery.
You can add assembly orders of any type to an empty supply: crossborder or non-crossborder. After adding the first assembly order, the supply acquires the type of this assembly order from the crossBorderType field.
After that, you can add to the supply only the assembly orders of the same type as the supply.
Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Supply ID

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

Assembly order IDs

Responses

Request samples

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

Response samples

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

Get Supply Details{{ /api/v3/supplies/{supplyId} }}

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

Returns supply details.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Supply ID

Responses

Response samples

Content type
application/json
{
  • "id": "WB-GI-1234567",
  • "isB2b": true,
  • "isPickupPointShipmentAllowed": true,
  • "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,
  • "crossBorderType": 1,
  • "destinationOfficeId": 123,
  • "recommendedWhId": 123569,
  • "shippingDt": "2026-08-31",
  • "shippingPointId": 100,
  • "shippingType": "transportCompany",
  • "waybillUuid": "550e8400-e29b-41d4-a716-384579387429",
  • "spotAvailable": true
}

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

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

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

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Supply ID

Responses

Response samples

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

Get Supply Assembly Order IDs{{ /api/marketplace/v3/supplies/{supplyId}/order-ids }}

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

The method returns assembly orders IDs assigned to the supply.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string

Supply ID

Responses

Response samples

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

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 item will automatically close the supply.

You can transfer the supply to delivery only if:

  • there is at least one assembly order
  • required labeling is specified for all assembly orders
  • labeling of all assembly orders passed validation

If the supply contains assembly orders with required UIN, make sure that you have created and uploaded the Delivery Contract Specification in advance. The GIIS DMDK takes about 30 minutes to process changes in UIN statuses.

It is required to specify the shipping parameters for supplies from Russian sellers to Russia shipping points. If the shipping method, shipping date, or shipping point is not specified, a 409 error is returned.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Supply ID

Responses

Response samples

Content type
application/json
{
  • "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
Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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 Shipping Units List{{ /api/v3/supplies/{supplyId}/trbx }}

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

Returns supply shipping units list.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Supply ID

Responses

Response samples

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

Add Shipping Units to the Supply{{ /api/v3/supplies/{supplyId}/trbx }}

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

Adds the required number of shipping units to the supply.

You should add shipping units only to supplies shipped to the pickup points. You can add shipping units to an open supply only. One shipping unit can contain several orders. For example, if a supply has 10 orders, distribute them into boxes: the system will allow creating no more than 5 shipping units. For 20 orders — no more than 10 shipping units, for 100 — no more than 50.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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

Supply ID

Request Body schema: application/json
amount
required
integer [ 1 .. 1000 ]

Shipping units amount to add to the supply

Responses

Request samples

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

Response samples

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

Delete Shipping Units from the Supply{{ /api/v3/supplies/{supplyId}/trbx }}

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

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

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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 shipping unit IDs to delete from the supply

Responses

Request samples

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

Response samples

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

Get the Supply Shipping Unit 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 shipping unit.
Stickers dimensions: 580x400 px.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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 shipping unit 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.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Returns a list of all seller passes.

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Pass{{ /api/v3/passes }}

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

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

Maximum of 1 request per 10 minutes per one seller account

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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 pass detail

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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 pass

Request limit per one seller account for FBS assembly orders, supplies, passes and auto-return settings methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

One request with 4XX response codes is counted as 10 requests.

In Sandbox — maximum of 1 request per second for all Marketplace methods in total.

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": "ag-marketplace",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}