In-Store Pickup Orders (instorepickup)
Management of assembly orders and order metadata for the In-Store Pickup scheme.
Management of assembly orders and order metadata for the In-Store Pickup scheme.
Work order by scheme:
- Get new assembly order
- Transfer it for assembly
- After this, information about the buyer (name, phone number) becomes available for the order.
- After assembly, report that the assembly order is ready for pickup
- After the assembly order receives the status Ready for pickup, you can check whether the assembly order belongs to the buyer.
- 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.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
Responses
Response samples
- 200
- 401
- 403
- 429
{- "orders": [
- {
- "ddate": "29.10.2024",
- "salePrice": 14000,
- "requiredMeta": [
- "sgtin"
], - "article": "wb1702fyjh",
- "rid": "1234567673554519872.0.0",
- "createdAt": "2024-10-29T10:19:30Z",
- "warehouseAddress": "Москва, район Якиманка, Софийская набережная, 4 с1",
- "orderCode": "23457822-6667",
- "payMode": "prepaid",
- "skus": [
- "2041546265353"
], - "id": 1234567890,
- "warehouseId": 1234567,
- "nmId": 123456789,
- "chrtId": 987654321,
- "price": 14000,
- "finalPrice": 14000,
- "convertedFinalPrice": 14000,
- "convertedPrice": 14000,
- "convertedCurrencyCode": 643,
- "currencyCode": 643,
- "cargoType": 1,
- "isZeroOrder": false
}
]
}Transfer to assembly{{ /api/v3/click-collect/orders/{orderId}/confirm }}
The method transfers the assembly order to the status confirm — on assembly.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "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.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "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 assemblyprepare— ready for pickup
Restrictions:
- Information can only be obtained for assembly orders that are in the assembly process — status
confirmand ready for pickup — statusprepare.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
Request Body schema: application/jsonrequired
| orders | Array of integers Assembly orders IDs list |
Responses
Request samples
- Payload
{- "orders": [
- 1234567
]
}Response samples
- 200
- 400
- 401
- 403
- 429
{- "orders": [
- {
- "orders": [
- {
- "phone": "+71111111111",
- "firstName": "Иван",
- "orderID": 1234567,
- "phoneCode": 1234567
}
]
}
]
}Check if the assembly order belongs to the buyer{{ /api/v3/click-collect/orders/client/identity }}
The method indicates whether the checked assembly order belongs to the buyer based on the provided code.
Available only for assembly orders with the prepare status — ready for pickup.
One request with a response code of
409 is counted as 10 requests.
Authorizations:
Request Body schema: application/jsonrequired
| orderCode | string Unique buyer order ID |
| passcode | string Confirmation code |
Responses
Request samples
- Payload
{- "orderCode": "170046918-0011",
- "passcode": "4567"
}Response samples
- 200
- 400
- 401
- 403
- 409
- 429
{- "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.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "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.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "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 | PATCH /api/v3/click-collect/orders/{orderId}/confirm |
prepare |
Ready for pickup | PATCH /api/v3/click-collect/orders/{orderId}/prepare |
receive |
Received by buyer | PATCH /api/v3/click-collect/orders/{orderId}/receive |
reject |
Buyer refusal | PATCH /api/v3/click-collect/orders/{orderId}/reject |
cancel |
Canceled by seller | PATCH /api/v3/click-collect/orders/{orderId}/cancel |
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
One request with a response code of
409 is counted as 5 requests.
Authorizations:
Request Body schema: application/jsonrequired
| orders | Array of integers Assembly orders IDs list |
Responses
Request samples
- Payload
{- "orders": [
- 1234567
]
}Response samples
- 200
- 400
- 401
- 403
- 429
{- "orders": [
- {
- "orders": [
- {
- "supplierStatus": "confirm",
- "wbStatus": "waiting",
- "id": 1234567
}
]
}
]
}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.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
query Parameters
| limit required | integer 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
- 200
- 400
- 401
- 403
- 429
{- "next": 12345566,
- "orders": [
- {
- "article": "wb6scpbwvp",
- "cargoType": 1,
- "chrtId": 12345676,
- "price": 5000,
- "finalPrice": 5000,
- "convertedFinalPrice": 5000,
- "convertedCurrencyCode": 643,
- "convertedPrice": 5000,
- "createdAt": "2025-03-21T09:53:31Z",
- "currencyCode": 643,
- "id": 123456789,
- "isZeroOrder": false,
- "nmId": 1234567898765,
- "orderCode": "21117866-0006",
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "payMode": "prepaid",
- "rid": "5044304527347733263.0.0",
- "skus": [
- "2043227963145"
], - "warehouseAddress": "Москва, район Якиманка, Софийская набережная, 4 с1",
- "warehouseId": 1162157
}
]
}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.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter is passed"
}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.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Responses
Response samples
- 200
- 401
- 403
- 404
- 429
{- "meta": {
- "gtin": {
- "value": "123456789012345"
}, - "imei": {
- "value": "123456789012345"
}, - "sgtin": {
- "value": [
- "123456789012345"
]
}, - "uin": {
- "value": "123456789012345"
}
}
}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.
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
query Parameters
| key required | string The name of the metadata to be deleted ( |
Responses
Response samples
- 401
- 403
- 404
- 429
{- "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.
1. Assign UIN to the assembly order
2. Assign IMEI to the assembly order
3. Assign GTIN to the assembly order
4. Assign Data Matrix code to the assembly order
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Request Body schema: application/jsonrequired
| sgtins | Array of strings List of Data Matrix codes. From 16 to 135 symbols for one Data Matrix code |
Responses
Request samples
- Payload
{- "sgtins": [
- "1234567890123456"
]
}Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter is passed"
}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.
1. Assign UIN to the assembly order
2. Assign IMEI to the assembly order
3. Assign GTIN to the assembly order
4. Assign Data Matrix code to the assembly order
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Request Body schema: application/jsonrequired
| uin | string UIN |
Responses
Request samples
- Payload
{- "uin": [
- "1234567890123456"
]
}Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter is passed"
}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.
1. Assign UIN to the assembly order
2. Assign IMEI to the assembly order
3. Assign GTIN to the assembly order
4. Assign Data Matrix code to the assembly order
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Request Body schema: application/jsonrequired
| imei | string IMEI |
Responses
Request samples
- Payload
{- "imei": [
- "123456789012345"
]
}Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter is passed"
}Закрепить за сборочным заданием 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.
1. Assign UIN to the assembly order
2. Assign IMEI to the assembly order
3. Assign GTIN to the assembly order
4. Assign Data Matrix code to the assembly order
One request with a response code of
409 is counted as 5 requests.
Authorizations:
path Parameters
| orderId required | integer Assembly order ID |
Request Body schema: application/jsonrequired
| gtin | string GTIN |
Responses
Request samples
- Payload
{- "gtin": [
- "1234567890123456"
]
}Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter is passed"
}