Wildberries API TypeScript SDK / InStorePickupModule

Class: InStorePickupModule

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

Constructors

Constructor

new InStorePickupModule(client: BaseClient): InStorePickupModule;

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

Parameters

Parameter	Type
client	BaseClient

Returns

InStorePickupModule

Methods

getOrdersNew()

getOrdersNew(): Promise<ApiNewOrders>;

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

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

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

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);

---

updateOrdersConfirm()

updateOrdersConfirm(orderId: number): Promise<void>;

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

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

Метод переводит сборочное задание в статус confirm — на сборке.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.updateOrdersConfirm(12345);

---

updateOrdersPrepare()

updateOrdersPrepare(orderId: number): Promise<void>;

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

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

Метод переводит сборочное задание в статус prepare — готово к выдаче.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.updateOrdersPrepare(12345);

---

createOrdersClient()

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

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

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

Метод возвращает информацию о покупателе по 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:135

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

Метод сообщает, принадлежит ли проверяемый заказ покупателю или нет по переданному коду. Доступно, если хотя бы одно сборочное задание из заказа находится в статусе 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);

---

updateOrdersReceive()

updateOrdersReceive(orderId: number): Promise<void>;

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

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

Метод переводит сборочное задание в статус receive — получено покупателем.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.updateOrdersReceive(12345);

---

updateOrdersReject()

updateOrdersReject(orderId: number): Promise<void>;

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

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

Метод переводит сборочное задание в статус reject — отказ при получении.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.updateOrdersReject(12345);

---

createOrdersStatus()

createOrdersStatus(data: ApiOrdersRequest): Promise<ApiOrderStatuses>;

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

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

Метод возвращает статусы сборочных заданий по их ID.

Parameters

Parameter	Type	Description
data	ApiOrdersRequest	Request body data

Returns

Promise<ApiOrderStatuses>

Статусы сборочных заданий

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.createOrdersStatus({ orders: [12345] });
console.log(result);

---

getClickCollectOrders()

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

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

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

Метод возвращает информацию о завершённых сборочных заданиях после продажи или отмены заказа. Можно получить данные за заданный период, максимум 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);

---

updateOrdersCancel()

updateOrdersCancel(orderId: number): Promise<void>;

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

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

Метод отменяет сборочное задание и переводит в статус cancel — отменено продавцом.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.updateOrdersCancel(12345);

---

getOrdersMeta()

getOrdersMeta(orderId: number): Promise<ApiOrdersMeta>;

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

Получить метаданные сборочного задания

Метод возвращает метаданные сборочного задания. Перечень метаданных, доступных для сборочного задания, можно получить в списке новых сборочных заданий, поле requiredMeta.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания

Returns

Promise<ApiOrdersMeta>

Метаданные сборочного задания

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.getOrdersMeta(12345);
console.log(result);

---

deleteOrdersMeta()

deleteOrdersMeta(orderId: number, options: {
  key: string;
}): Promise<void>;

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

Удалить метаданные сборочного задания

Метод удаляет значение метаданных сборочного задания для переданного ключа. Возможные метаданные: imei, uin, gtin, sgtin. Передается только одно значение.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания
options	{ key: string; }	Query parameters
options.key	string	Metadata key to delete (imei, uin, gtin, sgtin)

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.deleteOrdersMeta(12345, { key: 'imei' });

---

updateMetaSgtin()

updateMetaSgtin(orderId: number, data: ApiSGTINsRequest): Promise<void>;

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

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

Метод закрепляет за сборочным заданием код маркировки Честный знак. Закрепить код маркировки можно только, если в метаданных есть поле sgtins, а сборочное задание находится в статусе confirm.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания
data	ApiSGTINsRequest	Request body data

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.updateMetaSgtin(12345, { sgtins: ['1234567890123456'] });

---

updateMetaUin()

updateMetaUin(orderId: number, data: ApiUINRequest): Promise<void>;

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

Закрепить за сборочным заданием УИН (уникальный идентификационный номер)

Метод обновляет УИН сборочного задания. У одного сборочного задания может быть только один УИН. Добавлять маркировку можно только для сборочных заданий в статусе confirm.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания
data	ApiUINRequest	Request body data

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.updateMetaUin(12345, { uin: '1234567890123456' });

---

updateMetaImei()

updateMetaImei(orderId: number, data: ApiIMEIRequest): Promise<void>;

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

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

Метод обновляет IMEI сборочного задания. У одного сборочного задания может быть только один IMEI. Добавлять маркировку можно только для сборочных заданий в статусе confirm.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания
data	ApiIMEIRequest	Request body data

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.updateMetaImei(12345, { imei: '123456789012345' });

---

updateMetaGtin()

updateMetaGtin(orderId: number, data: ApiGTINRequest): Promise<void>;

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

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

Метод обновляет GTIN (уникальный ID товара в Беларуси) сборочного задания. У одного сборочного задания может быть только один GTIN. Добавлять маркировку можно только для сборочных заданий в статусе confirm.

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания
data	ApiGTINRequest	Request body data

Returns

Promise<void>

Response data

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

await sdk.inStorePickup.updateMetaGtin(12345, { gtin: '1234567890123456' });