Search
API docs by Redocly

Seller API Test Environment

Use the test scope of the service to set up the integration.
For authorization you need to use the token with the Test scope type.

The data in the test scope is randomly generated and does not belong to real sellers.
The using of the test scope does not carry the risk of unintentional disclosure of information.

Seller API Test Environment

Use the test scope of the service to set up the integration.
For authorization you need to use the token with the Test scope type.

The data in the test scope is randomly generated and does not belong to real sellers.
The using of the test scope does not carry the risk of unintentional disclosure of information.

Promotion

To access the test environment, use the https://advert-api-sandbox.wildberries.ru address.
Campaigns will be deleted 30 days after the last modifications.
Deleted campaigns (-1 status) will be removed after 3 minutes.
A maximum of 50 campaigns can be created.
The maximum number of requests is the same as in the main API.

Statistics are generated only for campaigns of type 8 — automatic campaign and 9 — Auction.
To generate statistics:

  • the campaign must be in status 9— on display
  • type 8 campaign must have a positive bid
  • type 9 campaign must have a positive bid in the catalog
  • the campaign budget must be positive

    Ypu can create product cards in the content sandbox and use created nomenclatures in the promotion sandbox.

Top-up test balance{{ /adv/v1/test/update/balance }}

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

Updates test balance, account and bonuses

Authorizations:
HeaderApiKey
Request Body schema: application/json
balance
integer

Account top-up amount, ₽

net
integer

Balance top-up amount, ₽

bonus
integer

Bonuses top-up amount, ₽

Responses

Request samples

Content type
application/json
{
  • "balance": 1000,
  • "net": 1000,
  • "bonus": 1000
}

Response samples

Content type
application/json
{
  • "balance": 9100,
  • "net": 8000,
  • "bonus": 10000
}

Marketplace FBS

To access the test environment, use the https://marketplace-api-sandbox.wildberries.ru address.

You can create product cards in the content sandbox and use the generated product card barcodes in the marketplace sandbox.

Regular expressions are used for:

  • Supplies IDs — ^WB-GI-SAND-[0-9]+$
  • Boxes IDs — ^WB-TRBX-SAND-[0-9]+$

Status Model for FBS

There are two types of statuses for the assembly orders:

  1. supplierStatus — a status that can be changed by the seller.
  2. wbStatus — a status in the system. It can only be changed by WB.

In the sandbox, you can emulate WB actions by manually changing the wbStatus field. Use the following statuses:

wbStatus supplierStatus Description How to move the order to this status
waiting new New assembly order Create a test FBS assembly order
declined_by_client new The assembly order was canceled by the buyer. It is available for one hour after creating an assembly order, only in the sandbox. Notify that the buyer has canceled the order
waiting confirm On assembly Add the order to the supply
canceled cancel The assembly order was canceled by the seller. Available at any stage until the supply is moved to the delivery. Cancel the assembly order
waiting complete In delivery Move the supply to the delivery
sorted complete WB has accepted the assembly order Close supply
ready_for_pickup complete The order has arrived at the pickup point Notify that the order has arrived at the pickup point
sold complete The buyer has received the order at the pickup point Notify that the order has been accepted by the buyer
canceled_by_client complete The buyer has canceled the order upon receipt at the pickup point Notify that the buyer has declined the order
defect complete The buyer has canceled the order due to a defect Notify that the buyer has canceled the order due to a defect

Create a test FBS assembly order{{ /api/v3/test/fbs/orders/make }}

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

The method allows you to create a test FBS assembly order, emulating buyer's actions.

A single request creates assembly orders for products from one buyer's cart. They share a single transaction ID — orderUid, which is included in the responses of methods for retrieving new and all assembly orders.

An assembly order could be created if:

  1. All product barcodes from the request have inventory in FBS warehouses.
  2. The inventory in the warehouse is greater than or equal to the amount in the request.
  3. The price of the product is not zero.
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects or null (MakeOrder) [ 1 .. 10 ] items

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Notify that the buyer has canceled the order{{ /api/v3/test/fbs/orders/{orderId}/decline }}

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

Method transfers the assembly order to the status "wbStatus":"declined_by_client" — declined by the buyer. It is available for one hour after creating an assembly order.

The method emulates WB actions

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64> >= 1

Assembly order ID

Request Body schema: application/json
required
code
required
string

Order retrieval code. In the test environment, you can use any combination of characters.

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Close supply{{ /api/v3/test/fbs/supplies/{supplyId}/close }}

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

The method closes the FBS supply and marks all assembly orders as requiring reshipment.

All orderId listed in the request are marked as requiring reshipment. Unspecified orderId related to the given supplyId are set to "wbStatus": "sorted".

The method emulates WB actions

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string^WB-GI-SAND-[0-9]+$

Supply ID

Request Body schema: application/json
orderIds
required
Array of integers or null <int64> >= 0

Responses

Request samples

Content type
application/json
{
  • "orderIds": 9007199254740991
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Notify that the order has arrived at the pickup point{{ /api/v3/test/fbs/orders/{orderId}/deliver }}

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

Method transfers the assembly order to the status "wbStatus":"ready_for_pickup" — the order has arrived at the pickup point.

The method emulates WB actions

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64> >= 1

Assembly order ID

Request Body schema: application/json
required
code
required
string

Order retrieval code. In the test environment, you can use any combination of characters.

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Notify that the order has been accepted by the buyer{{ /api/v3/test/fbs/orders/{orderId}/receive }}

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

Method transfers the assembly order to the status "wbStatus":"sold" — received by the buyer.

The method emulates WB actions

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64> >= 1

Assembly order ID

Request Body schema: application/json
code
required
string

Order retrieval code. In the test environment, you can use any combination of characters.

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Notify that the buyer has declined the order{{ /api/v3/test/fbs/orders/{orderId}/reject }}

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

Method transfers the assembly order to the status "wbStatus":"canceled_by_client" — declined upon receipt.

The method emulates WB actions

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64> >= 1

Assembly order ID

Request Body schema: application/json
code
required
string

Order retrieval code. In the test environment, you can use any combination of characters.

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Notify that the buyer has canceled the order due to a defect{{ /api/v3/test/fbs/orders/{orderId}/defect }}

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

Method transfers the assembly order to the status "wbStatus":"defect" — cancellation of the order due to a defect.

The method emulates WB actions

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64> >= 1

Assembly order ID

Responses

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Marketplace DBS

To access the test environment, use the https://marketplace-api-sandbox.wildberries.ru address.

You can create product cards in the content sandbox and use the generated product card barcodes in the marketplace sandbox.

For the order retrieval code in the confirmation of receipt and rejection of receipt methods, you can use any combination of characters.

Status Model for DBS

There are two types of statuses for the assembly orders:

  1. supplierStatus — a status that can be changed by the seller.
  2. wbStatus — a status in the system. It can only be changed by WB.

In the sandbox, you can emulate WB actions by manually changing the wbStatus field. Use the following statuses:

wbStatus supplierStatus Description How to move the order to this status
waiting new New assembly order Create a test DBS assembly order
declined_by_client new The assembly order was canceled by the buyer. It is available for one hour after creating an assembly order, only in the sandbox. Notify that the buyer has canceled the order
canceled cancel The assembly order was canceled by the seller. Available before transferring the assembly order to assembly. Cancel the assembly order
waiting confirm On assembly Transfer assembly order to assembly
waiting deliver In delivery Transfer assembly order to delivery
sold receive The buyer has received the order Notify that the order has been accepted by the buyer
canceled_by_client reject The buyer has canceled the order upon receipt Notify that the buyer has declined the order

Create a test DBS assembly order{{ /api/v3/test/dbs/orders/make }}

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

The method allows you to create a test DBS assembly order, emulating buyer's actions.

A single request creates assembly orders for products from one buyer's cart. They share a single transaction ID — orderUid, which is included in the responses of methods for retrieving new and completed assembly orders.

An assembly order could be created if:

  1. All product barcodes from the request have inventory in DBS warehouses.
  2. The inventory in the warehouse is greater than or equal to the amount in the request.
  3. The price of the product is not zero.

    Specify the delivery address for the assembly order in the request body. By default, the address is set to г.Москва, Сумская улица, 6к5, кв. 5545.
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects [ 1 .. 10 ] items

Array of product barcodes and product inventory for the assembly order

object

Delivery address of the assembly order.
Specify the address without abbreviations, as in the request example.If no address is specified, the default address is used — Москва, Сумская улица, 6к5, кв. 5545

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Notify that the buyer has canceled the order{{ /api/v3/test/dbs/orders/{orderId}/decline }}

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

Method transfers the assembly order to the "wbStatus":"declined_by_client" — declined by the buyer. It is available for one hour after creating an assembly order.

The method emulates WB actions

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64> >= 1

Assembly order ID

Responses

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Marketplace In-Store Pickup

To access the test environment, use the https://marketplace-api-sandbox.wildberries.ru address.

You can create product cards in the content sandbox and use the generated product card barcodes in the marketplace sandbox.

Regular expressions are used for:

  • Supplies IDs — ^WB-GI-SAND-[0-9]+$
  • Boxes IDs — ^WB-TRBX-SAND-[0-9]+$
Always specify the combination "11111" in the passCode request parameter of the test method for checking if the assembly task belongs to the buyer.

Status Model for In-Store Pickup

There are two types of statuses for the assembly orders:

  1. supplierStatus — a status that can be changed by the seller.
  2. wbStatus — a status in the system. It can only be changed by WB.

In the sandbox, you can emulate WB actions by manually changing the wbStatus field. Use the following statuses:

wbStatus supplierStatus Description How to move the order to this status
waiting new New assembly order Create a test In-Store Pickup assembly order
declined_by_client new The assembly order was canceled by the buyer. It is available for one hour after creating an assembly order, only in the sandbox. Notify that the buyer has canceled the order
waiting confirm On assembly Transfer assembly order to assembly
canceled cancel The assembly order was canceled by the seller. Available before notifying that the assembly order is ready for pickup. Cancel the assembly order
ready_for_pickup prepare The assembly order is ready for pickup Notify that the assembly order is ready for pickup
sold receive The buyer has received the order Notify that the order has been accepted by the buyer
canceled_by_client reject The buyer has canceled the order upon receipt Notify that the buyer has declined the order

Create a test In-Store Pickup assembly order{{ /api/v3/test/click-collect/orders/make }}

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

The method allows you to create a test In-Store Pickup assembly order, emulating buyer's actions.

A single request creates assembly orders for products from one customer's cart. They share a single transaction ID — orderUid, which is included in the responses of methods for retrieving new and completed assembly orders.

An assembly order could be created if:

  1. All product barcodes from the request have inventory in warehouses.
  2. The inventory in the warehouse is greater than or equal to the amount in the request.
  3. The price of the product is not zero.
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects or null (MakeOrder) [ 1 .. 10 ] items

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}

Notify that the buyer has canceled the order{{ /api/v3/test/click-collect/orders/{orderId}/decline }}

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

Method transfers the assembly order to the "wbStatus":"declined_by_client" — declined by the buyer. It is available for one hour after creating an assembly order.

The method emulates WB actions

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64> >= 1

Assembly order ID

Responses

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectParameter",
  • "message": "Incorrect parameter"
}