Search
API docs by Redocly

In-Store Pickup Orders (instorepickup)

Management of assembly orders and order metadata for the In-Store Pickup scheme.

In-Store Pickup Orders

Management of assembly orders and order metadata for the In-Store Pickup scheme.

In-Store Pickup Assembly Orders

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

Work order by scheme:

  1. Get new assembly order
  2. Transfer it for assembly
  3. After this, information about the buyer (name, phone number) becomes available for the order.
  4. After assembly, report that the assembly order is ready for pickup
  5. After the assembly order receives the status Ready for pickup, you can check whether the assembly order belongs to the buyer.
  6. After delivering the order to the buyer, you need to inform our server that the assembly order has been received by the buyer or that the buyer declined the assembly order.

Get New Assembly Orders List{{ /api/v3/click-collect/orders/new }}

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

The method provides a list of all new assembly orders that the seller has at the time of the request.

Request limit per one seller's account for In-Store Pickup assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

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

Authorizations:
HeaderApiKey

Responses

Response samples

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

Transfer to Assembly{{ /api/marketplace/v3/click-collect/orders/status/confirm }}

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

The method transfers assembly orders from the new status to the confirm — on assembly — status.

Request limit per one seller's account for In-Store Pickup assembly orders methods:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Notify That the Assembly Orders Are Ready for Pickup{{ /api/marketplace/v3/click-collect/orders/status/prepare }}

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

The method transfers assembly orders from the confirm — on assembly — status to the prepare — ready for pickup — status.

Request limit per one seller's account for In-Store Pickup assembly orders methods:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Transfer to Assembly{{ /api/v3/click-collect/orders/{orderId}/confirm }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Responses

Response samples

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

Notify That the Assembly Order Is Ready for Pickup{{ /api/v3/click-collect/orders/{orderId}/prepare }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Responses

Response samples

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

Buyer Information{{ /api/v3/click-collect/orders/client }}

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

The method provides information about the buyer based on the assembly order ID.

Available only for assembly orders with the following statuses:

  • confirm — in assembly
  • prepare — ready for pickup

Restrictions:

  • Information can only be obtained for assembly orders that are in the assembly process — status confirm and ready for pickup — status prepare.
Request limit per one seller's account for In-Store Pickup assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Assembly orders IDs list

Responses

Request samples

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

Response samples

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

Check If the Order Belongs to the Buyer{{ /api/v3/click-collect/orders/client/identity }}

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

The method indicates whether the checked order belongs to the buyer based on the provided code.

Available if at least one assembly order from the order is in prepare status — ready for pickup.

Request limit per one seller's account:
Period Limit Interval Burst
1 min 30 requests 2 s 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orderCode
string

Unique buyer order ID

passcode
string

Confirmation code

Responses

Request samples

Content type
application/json
{
  • "orderCode": "170046918-0011",
  • "passcode": "4567"
}

Response samples

Content type
application/json
{
  • "ok": true
}

Notify That the Orders Were Received by the Buyers{{ /api/marketplace/v3/click-collect/orders/status/receive }}

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

The method transfers assembly orders from the prepare — ready for pickup — status to the receive — received by the buyer — status.

Request limit per one seller's account for In-Store Pickup assembly orders methods:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Notify that the Orders Are Declined{{ /api/marketplace/v3/click-collect/orders/status/reject }}

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

The method transfers assembly orders from the prepare — ready for pickup — status to the reject — refusal upon receipt — status.

Request limit per one seller's account for In-Store Pickup assembly orders methods:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Notify That the Order Has Been Accepted by the Buyer{{ /api/v3/click-collect/orders/{orderId}/receive }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Responses

Response samples

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

Notify That the Buyer Refused the Order{{ /api/v3/click-collect/orders/{orderId}/reject }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Responses

Response samples

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

Get Assembly Order Statuses{{ /api/marketplace/v3/click-collect/orders/status/info }}

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

The method provides the statuses of assembly orders by their ID.

supplierStatus — the status of the assembly order. The trigger for its change is the action of the seller himself.

Possible values for supplierStatus:

Status Description How to set the assembly order to this status
new New assembly order
confirm In assembly Transfer to assembly
prepare Ready for pickup Notify that the assembly order is ready for delivery
receive Received by buyer Notify that the order has been received by the buyer
reject Buyer refusal Notify that the buyer has declined the order
cancel Canceled by seller Cancel the order
cancel_shelf_life Canceled due to shelf life expiration Automatically transitions upon event occurrence

wbStatus — the status of the assembly order in the WB system.

Possible values for wbStatus:

  • waiting - assembly order is in progress
  • sorted - assembly order is sorted
  • sold - the buyer got the order
  • canceled - assembly order canceled
  • canceled_by_client - buyer canceled the order upon receipt
  • declined_by_client - buyer canceled the order within the first hour
    Cancellation is available to the buyer within the first hour from the time of order, if the order has not been transitioned to assembly
  • defect - order canceled due to defect
  • ready_for_pickup - assembly order is ready for pickup
Request limit per one seller's account for In-Store Pickup assembly orders methods:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

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

List of assembly order IDs

Responses

Request samples

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

Response samples

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

Get Assembly Order Statuses{{ /api/v3/click-collect/orders/status }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Assembly orders IDs list

Responses

Request samples

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

Response samples

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

Retrieve Information on Completed Assembly Orders{{ /api/v3/click-collect/orders }}

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

The method provides information on completed assembly orders after the sale or cancellation of an order.

You can get data for a specified period, maximum of 30 calendar days per request.

Request limit per one seller's account for In-Store Pickup assembly orders methods:
Period Limit Interval Burst
1 min 300 requests 200 ms 20 requests

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

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Pagination parameter. Sets the maximum number of returned data.

next
required
integer

Pagination parameter. Sets the value from which the next batch of data should be retrieved. To obtain the complete list of data, it should be set to 0 in the first request. For subsequent requests, the values should be taken from the field with the same name in the response.

dateFrom
required
integer

Period start date in the Unix timestamp format

dateTo
required
integer

Period end date in the Unix timestamp format

Responses

Response samples

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

Cancel the Assembly Orders{{ /api/marketplace/v3/click-collect/orders/status/cancel }}

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

The method transfers assembly orders from the new, confirm, prepare statuses to the cancel — canceled by the seller — status.

Request limit per one seller's account for In-Store Pickup assembly orders methods:
Period Limit Interval Burst
1 s 1 request 1 s 10 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Cancel the Assembly Order{{ /api/v3/click-collect/orders/{orderId}/cancel }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Responses

Response samples

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

In-Store Pickup Metadata

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

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

Get Assembly Orders Metadata{{ /api/marketplace/v3/click-collect/orders/meta/info }}

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

Returns assembly orders metadata.

The list of metadata available for the assembly order can be got in the list of new assembly orders, field requiredMeta.

Request limit per one seller's account for all methods for getting and deleting In-Store Pickup metadata:
Period Limit Interval Burst
1 min 150 requests 400 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
Array of integers <= 1000 items

List of assembly order IDs

Responses

Request samples

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

Response samples

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

Delete Assembly Order Metadata{{ /api/marketplace/v3/click-collect/orders/meta/delete }}

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

The method removes assembly orders metadata values.

You can only remove one type of metadata in one request: imei, uin, gtin or sgtin.

Request limit per one seller's account for all methods for getting and deleting In-Store Pickup metadata:
Period Limit Interval Burst
1 min 150 requests 400 ms 20 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
key
required
string

Metadata type to delete (imei, uin, gtin, sgtin). Only one value is passed

ordersIds
required
Array of integers <= 1000 items

Assembly orders IDs list

Responses

Request samples

Content type
application/json
{
  • "key": "imei",
  • "ordersIds": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Add Data Matrix Codes to the Assembly Orders (Chestny ZNAK){{ /api/marketplace/v3/click-collect/orders/meta/sgtin }}

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

The method sets Data Matrix codes (Chestny ZNAK) to the assembly orders metadata.

You can set the Data Matrix codes only for orders in the confirm status and if the field sgtin is returned in the response of the Get order metadata method.
You can get the uploaded Data Matrix codes in the assembly orders metadata.

For more information about Data Matrix Codes please check: https://chestnyznak.ru/en/.

Request limit per one seller's account for all methods for adding In-Store Pickup metadata:
Period Limit Interval Burst
1 min 20 requests 3 s 500 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (api.SGTINs) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Add UIN (Unique Identification Numbers) to the Assembly Orders{{ /api/marketplace/v3/click-collect/orders/meta/uin }}

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

The method sets the UIN (Unique Identification Numbers) for the assembly orders metadata. The order can only have one UIN. You can add the UIN only for assembly orders in the confirm status and that are delivered by WB.

Request limit per one seller's account for all methods for adding In-Store Pickup metadata:
Period Limit Interval Burst
1 min 20 requests 3 s 500 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (api.UIN) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Add IMEI to the Assembly Orders{{ /api/marketplace/v3/click-collect/orders/meta/imei }}

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

Sets the IMEI for the assembly orders metadata.
The assembly order can have only one IMEI. You can add the IMEI only for assembly orders in the confirm status that are delivered by Wildberries.

Request limit per one seller's account for all methods for adding In-Store Pickup metadata:
Period Limit Interval Burst
1 min 20 requests 3 s 500 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (api.IMEI) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Add GTIN to the Assembly Orders{{ /api/marketplace/v3/click-collect/orders/meta/gtin }}

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

The method sets the GTIN, Belarus product unique identifier, for the for the assembly orders metadata. The assembly order can only have one GTIN. You can add the GTIN only for assembly orders in the confirm status and that are delivered by WB.

Request limit per one seller's account for all methods for adding In-Store Pickup metadata:
Period Limit Interval Burst
1 min 20 requests 3 s 500 requests

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

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects (api.GTIN) <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Get Assembly Order Metadata{{ /api/v3/click-collect/orders/{orderId}/meta }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Responses

Response samples

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

Delete Assembly Order Metadata{{ /api/v3/click-collect/orders/{orderId}/meta }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

query Parameters
key
required
string

The name of the metadata to be deleted (imei, uin, gtin, sgtin). Only one value is passed.

Responses

Response samples

Content type
application/problem+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"
}

Assign a Data Matrix Code to the Assembly Order{{ /api/v3/click-collect/orders/{orderId}/meta/sgtin }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Request Body schema: application/json
required
sgtins
Array of strings

List of Data Matrix codes. From 16 to 135 symbols for one Data Matrix code

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/click-collect/orders/{orderId}/meta/uin }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Request Body schema: application/json
required
uin
string

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/click-collect/orders/{orderId}/meta/imei }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Request Body schema: application/json
required
imei
string

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/click-collect/orders/{orderId}/meta/gtin }} Deprecated

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

This method is deprecated. It will be removed on May 19

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

Assembly order ID

Request Body schema: application/json
required
gtin
string

GTIN

Responses

Request samples

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

Response samples

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