Wildberries API TypeScript SDK / InStorePickupModule

Class: InStorePickupModule

Defined in: modules/in-store-pickup/index.ts:39

Constructors

Constructor

new InStorePickupModule(client: BaseClient): InStorePickupModule;

Defined in: modules/in-store-pickup/index.ts:40

Parameters

Parameter	Type
`client`	`BaseClient`

Returns

InStorePickupModule

Methods

getOrdersNew()

getOrdersNew(): Promise<ApiNewOrders>;

Defined in: modules/in-store-pickup/index.ts:56

Получить список новых сборочных заданий

Метод возвращает список всех новых сборочных заданий, которые есть у продавца на момент запроса.

Returns

Promise<ApiNewOrders>

Список новых сборочных заданий

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.inStorePickup.getOrdersNew();
console.log(result);

confirmBulk()

confirmBulk(orderIds: number[]): Promise<BulkStatusChangeResponse>;

Defined in: modules/in-store-pickup/index.ts:81

Перевести на сборку (batch)

Moves up to 1000 assembly orders to confirm status in a single request. Replaces the dead single-order PATCH .../orders/{id}/confirm path.

Parameters

Parameter	Type	Description
`orderIds`	`number`[]	Array of assembly order IDs (1-1000 items)

Returns

Promise<BulkStatusChangeResponse>

Per-order confirmation results

Throws

When orderIds array is empty or exceeds 1000

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.confirmBulk([123456, 234567]);

prepareBulk()

prepareBulk(orderIds: number[]): Promise<BulkStatusChangeResponse>;

Defined in: modules/in-store-pickup/index.ts:114

Сообщить, что сборочное задание готово к выдаче (batch)

Moves up to 1000 assembly orders to prepare status (ready for pickup). Replaces the dead single-order PATCH .../orders/{id}/prepare path.

Parameters

Parameter	Type	Description
`orderIds`	`number`[]	Array of assembly order IDs (1-1000 items)

Returns

Promise<BulkStatusChangeResponse>

Per-order results

Throws

When orderIds array is empty or exceeds 1000

Throws

When B2B marking validation fails (409 — Chestny ZNAK; use checkMetaValidation for pre-flight)

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.prepareBulk([123456, 234567]);

createOrdersClient()

createOrdersClient(data: ApiOrdersRequest): Promise<ApiOrderClientInfoResp>;

Defined in: modules/in-store-pickup/index.ts:144

Информация о покупателе

Метод возвращает информацию о покупателе по ID сборочного задания. Доступно только для сборочных заданий в статусах confirm и prepare.

Parameters

Parameter	Type	Description
`data`	`ApiOrdersRequest`	Request body data

Returns

Promise<ApiOrderClientInfoResp>

Информация о покупателе

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.inStorePickup.createOrdersClient({ orders: [12345] });
console.log(result);

createClientIdentity()

createClientIdentity(data: ApiCheckIdentityRequest): Promise<ApiCheckedIdentity>;

Defined in: modules/in-store-pickup/index.ts:168

Проверить, что заказ принадлежит покупателю

Метод сообщает, принадлежит ли проверяемый заказ покупателю или нет по переданному коду. Доступно, если хотя бы одно сборочное задание из заказа находится в статусе prepare.

Parameters

Parameter	Type	Description
`data`	`ApiCheckIdentityRequest`	Request body data

Returns

Promise<ApiCheckedIdentity>

Результат проверки идентификации

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.inStorePickup.createClientIdentity({ orderCode: '170046918-0011', passcode: '4567' });
console.log(result);

receiveBulk()

receiveBulk(orderIds: number[]): Promise<BulkStatusChangeResponse>;

Defined in: modules/in-store-pickup/index.ts:196

Сообщить, что заказ принят покупателем (batch)

Moves up to 1000 assembly orders to receive status (received by buyer). Replaces the dead single-order PATCH .../orders/{id}/receive path.

NOTE: pickup receive takes NO passcodes (unlike DBS) — just order IDs.

Parameters

Parameter	Type	Description
`orderIds`	`number`[]	Array of assembly order IDs (1-1000 items)

Returns

Promise<BulkStatusChangeResponse>

Per-order results

Throws

When orderIds array is empty or exceeds 1000

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.receiveBulk([123456, 234567]);

rejectBulk()

rejectBulk(orderIds: number[]): Promise<BulkStatusChangeResponse>;

Defined in: modules/in-store-pickup/index.ts:230

Сообщить, что покупатель отказался от заказа (batch)

Moves up to 1000 assembly orders to reject status (buyer refused). Replaces the dead single-order PATCH .../orders/{id}/reject path.

NOTE: pickup reject takes NO passcodes (unlike DBS) — just order IDs.

Parameters

Parameter	Type	Description
`orderIds`	`number`[]	Array of assembly order IDs (1-1000 items)

Returns

Promise<BulkStatusChangeResponse>

Per-order results

Throws

When orderIds array is empty or exceeds 1000

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.rejectBulk([123456, 234567]);

getStatusesBulk()

getStatusesBulk(orderIds: number[]): Promise<GetStatusInfoResponse>;

Defined in: modules/in-store-pickup/index.ts:262

Получить статусы сборочных заданий (batch)

Returns statuses for up to 1000 assembly orders in a single request. Replaces the dead single-batch POST .../orders/status path.

Parameters

Parameter	Type	Description
`orderIds`	`number`[]	Array of assembly order IDs (1-1000 items)

Returns

Promise<GetStatusInfoResponse>

Status information for each order

Throws

When orderIds array is empty or exceeds 1000

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.getStatusesBulk([123456, 234567]);

getClickCollectOrders()

getClickCollectOrders(options?: {
  limit: number;
  next: number;
  dateFrom: number;
  dateTo: number;
}): Promise<ApiOrders>;

Defined in: modules/in-store-pickup/index.ts:292

Получить информацию о завершённых сборочных заданиях

Метод возвращает информацию о завершённых сборочных заданиях после продажи или отмены заказа. Можно получить данные за заданный период, максимум 30 календарных дней одним запросом.

Parameters

Parameter	Type	Description
`options?`	{ `limit`: `number`; `next`: `number`; `dateFrom`: `number`; `dateTo`: `number`; }	Query parameters
`options.limit?`	`number`	-
`options.next?`	`number`	-
`options.dateFrom?`	`number`	-
`options.dateTo?`	`number`	-

Returns

Promise<ApiOrders>

Список завершённых сборочных заданий

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Example

const result = await sdk.inStorePickup.getClickCollectOrders({ limit: 10, next: 0, dateFrom: 0, dateTo: 0 });
console.log(result);

cancelBulk()

cancelBulk(orderIds: number[]): Promise<BulkStatusChangeResponse>;

Defined in: modules/in-store-pickup/index.ts:322

Отменить сборочное задание (batch)

Moves up to 1000 assembly orders to cancel status (canceled by seller). Replaces the dead single-order PATCH .../orders/{id}/cancel path.

Parameters

Parameter	Type	Description
`orderIds`	`number`[]	Array of assembly order IDs (1-1000 items)

Returns

Promise<BulkStatusChangeResponse>

Per-order results

Throws

When orderIds array is empty or exceeds 1000

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.cancelBulk([123456, 234567]);

getMetaBulk()

getMetaBulk(request: GetMetaBulkRequest): Promise<GetOrderMetaBulkResponse>;

Defined in: modules/in-store-pickup/index.ts:354

Получить идентификаторы маркировки сборочных заданий (batch)

Returns label identifiers for up to 1000 assembly orders in a single request. Replaces the dead single-order GET .../orders/{id}/meta path.

Parameters

Parameter	Type	Description
`request`	`GetMetaBulkRequest`	Request with order IDs (max 1000)

Returns

Promise<GetOrderMetaBulkResponse>

Label identifiers for each order

Throws

When ordersIds array is empty or exceeds 1000

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.getMetaBulk({ ordersIds: [123456] });

deleteMetaBulk()

deleteMetaBulk(request: DeleteMetaBulkRequest): Promise<DeleteMetaBulkResponse>;

Defined in: modules/in-store-pickup/index.ts:387

Удалить идентификаторы маркировки сборочных заданий (batch)

Deletes one label-identifier type (imei/uin/gtin/sgtin/customsDeclaration) for up to 1000 assembly orders. Replaces the dead single-order DELETE .../orders/{id}/meta path.

Parameters

Parameter	Type	Description
`request`	`DeleteMetaBulkRequest`	Request with key + order IDs (max 1000)

Returns

Promise<DeleteMetaBulkResponse>

Per-order results

Throws

When ordersIds array is empty or exceeds 1000

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.deleteMetaBulk({ key: 'imei', ordersIds: [123456] });

setSgtinBulk()

setSgtinBulk(request: SetSgtinBulkRequest): Promise<SetMetaBulkResponse>;

Defined in: modules/in-store-pickup/index.ts:421

Закрепить за сборочными заданиями коды маркировки SGTIN (batch)

Sets Chestny ZNAK labeling codes for up to 1000 assembly orders. Replaces the dead single-order PUT .../orders/{id}/meta/sgtin path.

Parameters

Parameter	Type	Description
`request`	`SetSgtinBulkRequest`	Orders with SGTIN codes (max 1000)

Returns

Promise<SetMetaBulkResponse>

Per-order results

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.setSgtinBulk({
  orders: [{ orderId: 123456, sgtins: ['1234567890123456'] }]
});

setUinBulk()

setUinBulk(request: SetUinBulkRequest): Promise<SetMetaBulkResponse>;

Defined in: modules/in-store-pickup/index.ts:449

Закрепить за сборочными заданиями УИН (batch)

Sets UIN values for up to 1000 assembly orders. Replaces the dead single-order PUT .../orders/{id}/meta/uin path.

Parameters

Parameter	Type	Description
`request`	`SetUinBulkRequest`	Orders with UIN values (max 1000)

Returns

Promise<SetMetaBulkResponse>

Per-order results

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.setUinBulk({
  orders: [{ orderId: 123456, uin: '1234567890123456' }]
});

setImeiBulk()

setImeiBulk(request: SetImeiBulkRequest): Promise<SetMetaBulkResponse>;

Defined in: modules/in-store-pickup/index.ts:477

Закрепить за сборочными заданиями IMEI (batch)

Sets IMEI values for up to 1000 assembly orders. Replaces the dead single-order PUT .../orders/{id}/meta/imei path.

Parameters

Parameter	Type	Description
`request`	`SetImeiBulkRequest`	Orders with IMEI values (max 1000)

Returns

Promise<SetMetaBulkResponse>

Per-order results

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.setImeiBulk({
  orders: [{ orderId: 123456, imei: '123456789012345' }]
});

setGtinBulk()

setGtinBulk(request: SetGtinBulkRequest): Promise<SetMetaBulkResponse>;

Defined in: modules/in-store-pickup/index.ts:505

Закрепить за сборочными заданиями GTIN (batch)

Sets GTIN values for up to 1000 assembly orders. Replaces the dead single-order PUT .../orders/{id}/meta/gtin path.

Parameters

Parameter	Type	Description
`request`	`SetGtinBulkRequest`	Orders with GTIN values (max 1000)

Returns

Promise<SetMetaBulkResponse>

Per-order results

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

Since

3.17.0

Example

typescript

const result = await sdk.inStorePickup.setGtinBulk({
  orders: [{ orderId: 123456, gtin: '1234567890123' }]
});

checkMetaValidation()

checkMetaValidation(orders: number[]): Promise<CheckMetaValidationResponse>;

Defined in: modules/in-store-pickup/index.ts:539

Check marking-metadata validation (B2B Chestny ZNAK pre-flight)

Returns label-identifier validation statuses for assembly orders. Call BEFORE transferring an order to prepare to identify orders that would get 409 MetaValidationFail. WB deprecated bulk POST .../meta/info on July 15 — use this meta/details method instead.

Rate limit: 150 req/min, 400ms interval, burst 20 (4XX×10 penalty)

Parameters

Parameter	Type	Description
`orders`	`number`[]	Array of assembly order IDs (max 1000)

Returns

Promise<CheckMetaValidationResponse>

Per-order label identifiers + validation statuses

Throws

When orders array is empty or exceeds 1000

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Since

3.16.0

Example

typescript

const result = await sdk.inStorePickup.checkMetaValidation([123456, 234567]);
const invalid = result.orders.filter(o => o.isError);

setCustomsDeclarationBulk()

setCustomsDeclarationBulk(request: SetCustomsDeclarationBulkRequest): Promise<CustomsDeclarationSetResponse>;

Defined in: modules/in-store-pickup/index.ts:579

Bulk add customs declaration numbers + country-of-origin codes (B2B)

Sets customs declaration (ДТ) numbers + origin country codes for assembly orders (statuses confirm or prepare only). B2B requirement (since 2026-07-08): B2B orders MUST include originCountryCode (numeric ОКСМ code, https://esnsi.gosuslugi.ru/classifiers/16269). Invalid/missing code for a B2B order → HTTP 200 with InvalidOriginCountryCode in that order's errors[] (partial success — check results[].isError).

Rate limit: 20 req/min, 3s interval, burst 500 (4XX×10 penalty)

Parameters

Parameter	Type	Description
`request`	`SetCustomsDeclarationBulkRequest`	Orders with customs declarations + origin country codes

Returns

Promise<CustomsDeclarationSetResponse>

Per-order results

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Since

3.16.0

Example

typescript

const result = await sdk.inStorePickup.setCustomsDeclarationBulk({
  orders: [{ orderId: 123456, customsDeclaration: '10704010/010624/0000302', originCountryCode: '643' }]
});
const failed = result.results.filter(r => r.isError);

Class: InStorePickupModule ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Methods ​

getOrdersNew() ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

confirmBulk() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Since ​

Example ​

prepareBulk() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Throws ​

Since ​

Example ​

createOrdersClient() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

createClientIdentity() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

receiveBulk() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Since ​

Example ​

rejectBulk() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Since ​

Example ​

getStatusesBulk() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Since ​

Example ​

getClickCollectOrders() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Class: InStorePickupModule

Constructors

Constructor

Parameters

Returns

Methods

getOrdersNew()

Returns

Throws

Throws

Throws

Throws

Example

confirmBulk()

Parameters

Returns

Throws

Throws

Throws

Throws

Since

Example

prepareBulk()

Parameters

Returns

Throws

Throws

Throws

Throws

Throws

Since

Example

createOrdersClient()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

createClientIdentity()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

receiveBulk()

Parameters

Returns

Throws

Throws

Throws

Throws

Since

Example

rejectBulk()

Parameters

Returns

Throws

Throws

Throws

Throws

Since

Example

getStatusesBulk()

Parameters

Returns

Throws

Throws

Throws

Throws

Since

Example

getClickCollectOrders()

Parameters

Returns

Throws

Throws