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 accepted by the buyer or that the buyer refused 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.

Requests limit per one seller's account for all methods in the Marketplace category:
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": [
    ]
}

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

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

The method transfers the assembly order to the status confirm — on assembly.

Requests limit per one seller's account for all methods in the Marketplace category:
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

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

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

The method transfers the assembly order to the status prepare — ready for pickup.

Requests limit per one seller's account for all methods in the Marketplace category:
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

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.
Requests limit per one seller's account for all methods in the Marketplace category:
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

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 only for orders with the prepare status — ready for pickup.

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 30 requests 2 seconds 20 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 order has been accepted by the buyer{{ /api/v3/click-collect/orders/{orderId}/receive }}

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

The method transitions the assembly order to the status receive — received by the buyer.

Requests limit per one seller's account for all methods in the Marketplace category:
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

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

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

The method transitions the assembly order to the status reject — refusal upon receipt.

Requests limit per one seller's account for all methods in the Marketplace category:
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

Assembly order ID

Responses

Response samples

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

Get assembly order statuses{{ /api/v3/click-collect/orders/status }}

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

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

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 accepted 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 - assembly order received by buyer
  • 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 - assembly order canceled due to defect
  • ready_for_pickup - assembly order is ready for pickup
Requests limit per one seller's account for all methods in the Marketplace category:
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

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.

Requests limit per one seller's account for all methods in the Marketplace category:
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 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 order{{ /api/v3/click-collect/orders/{orderId}/cancel }}

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

The method cancels the assembly order and changes its status to cancel — canceled by the seller.

Requests limit per one seller's account for all methods in the Marketplace category:
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

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 retrieve, delete, and edit metadata of assembly orders:

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

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

The method provides metadata for an assembly order.

Possible metadata: imei, uin, gtin, sgtin

The response of the method returns the metadata available for the assembly order. If the response returns with an empty meta structure, it means the assembly order has no metadata, and adding them is not possible.

Requests limit per one seller's account for all methods in the Marketplace category:
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

Assembly order ID

Responses

Response samples

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

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

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

The method deletes the metadata value of an assembly order for the provided key. Possible metadata: imei, uin, gtin, sgtin. Only one value is passed.

Requests limit per one seller's account for all methods in the Marketplace category:
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

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

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

The method assigns a Data Matrix code (Chestny ZNAK)to the assembly order.

You can assign a Data Matrix code only if there is an sgtin field in the assembly order metadata and the assembly order is in the status confirm.

You can retrieve the uploaded Data Matrix codes in the assembly order metadata.

Requests limit per one seller's account for all methods for adding 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

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

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

The method sets the UIN for the order. The order can only have one UIN. You can add the code only for orders in the confirmed status and that are delivered by WB.

Requests limit per one seller's account for all methods for adding 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

Assembly order ID

Request Body schema: application/json
required
uin
string

UIN

Responses

Request samples

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

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

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

The method sets the IMEI for the order. The order can have only one IMEI. You can add the code only for orders in the confirmed status and that are delivered by WB.

Requests limit per one seller's account for all methods for adding 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

Assembly order ID

Request Body schema: application/json
required
imei
string

IMEI

Responses

Request samples

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

Response samples

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

Закрепить за сборочным заданием GTIN{{ /api/v3/click-collect/orders/{orderId}/meta/gtin }}

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

The method sets the GTIN (Belarus product unique identifier) for the order. The order can only have one GTIN. You can add the code only for orders in the confirmed status and that are delivered by WB.

Requests limit per one seller's account for all methods for adding 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

Assembly order ID

Request Body schema: application/json
required
gtin
string

GTIN

Responses

Request samples

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

Response samples

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