Wildberries API TypeScript SDK / InStorePickupModule

Class: InStorePickupModule

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

Constructors

Constructor

new InStorePickupModule(client: BaseClient): InStorePickupModule;

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

Parameters

Parameter	Type
client	BaseClient

Returns

InStorePickupModule

Methods

getOrdersNew()

getOrdersNew(): Promise<ApiNewOrders>;

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

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

Метод возвращает список всех новых сборочных заданий, которые есть у продавца на момент запроса. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для методов <strong>сборочных заданий Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 300 запросов | 200 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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.general.getOrdersNew();
console.log(result);

---

updateOrdersConfirm()

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

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

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

Метод переводит сборочное задание в статус confirm — на сборке. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 100 запросов | 600 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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

const result = await sdk.general.updateOrdersConfirm('orderId-value');

---

updateOrdersPrepare()

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

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

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

Метод переводит сборочное задание в статус prepare — готово к выдаче. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 100 запросов | 600 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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

const result = await sdk.general.updateOrdersPrepare('orderId-value');

---

createOrdersClient()

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

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

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

Метод возвращает информацию о покупателе по ID сборочного задания. <br><br> Доступно только для сборочных заданий в статусах: - confirm — на сборке - prepare — готов к выдаче <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для методов <strong>сборочных заданий Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 300 запросов | 200 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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.general.createOrdersClient({});
console.log(result);

---

createClientIdentity()

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

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

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

Метод сообщает, принадлежит ли проверяемый заказ покупателю или нет по переданному коду. <br><br> Доступно, если хотя бы одно сборочное задание из заказа находится в статусе prepare - готов к выдаче. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 30 запросов | 2 секунды | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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.general.createClientIdentity({});
console.log(result);

---

updateOrdersReceive()

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

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

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

Метод переводит сборочное задание в статус receive — получено покупателем. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 100 запросов | 600 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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

const result = await sdk.general.updateOrdersReceive('orderId-value');

---

updateOrdersReject()

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

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

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

Метод переводит сборочное задание в статус reject — отказ при получении. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 100 запросов | 600 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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

const result = await sdk.general.updateOrdersReject('orderId-value');

---

createOrdersStatu()

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

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

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

Метод возвращает статусы сборочных заданий по их ID. <br><br> supplierStatus — статус сборочного задания. Триггер его изменения - действие самого продавца. Возможные значения supplierStatus: | Статус | Описание | Как перевести сборочное задание в данный статус | | ------- | --------- | --------------------------------------| | new | Новое сборочное задание | | confirm | На сборке | Перевести сборочное задание на сборку | prepare | Готов к выдаче | Сообщить, что сборочное задание готово к выдаче | receive | Получено покупателем | Сообщить, что заказ принят покупателем | reject | Отказ покупателя при получении | Сообщить, что покупатель отказался от заказа | cancel | Отменено продавцом | Отменить сборочное задание | cancel_shelf_life | Отмена по истечении срока хранения | Переводится автоматически по возникновению события <br><br> wbStatus — статус системы Wildberries. Возможные значения wbStatus: - waiting - сборочное задание в работе - sold - заказ получен покупателем - canceled - отмена сборочного задания - canceled_by_client - покупатель отменил заказ при получении - declined_by_client - покупатель отменил заказ в первый чаc <br> Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборку - defect - отмена заказа по причине брака - ready_for_pickup - сборочное задание готово к выдаче <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для методов <strong>сборочных заданий Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 300 запросов | 200 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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.general.createOrdersStatu({});
console.log(result);

---

getClickCollectOrders()

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

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

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

Метод возвращает информацию о завершённых сборочных заданиях после продажи или отмены заказа. Можно получить данные за заданный период, максимум 30 календарных дней одним запросом. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для методов <strong>сборочных заданий Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 300 запросов | 200 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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.general.getClickCollectOrders({});
console.log(result);

---

updateOrdersCancel()

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

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

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

Метод отменяет сборочное задание и переводит в статус cancel — отменено продавцом. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 100 запросов | 600 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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

const result = await sdk.general.updateOrdersCancel('orderId-value');

---

getOrdersMeta()

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

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

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

Метод возвращает метаданные сборочного задания. <br><br> Перечень метаданных, доступных для сборочного задания, можно получить в списке новых сборочных заданий, поле requiredMeta. <br><br> <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов <strong>получения и удаления метаданных Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 300 запросов | 200 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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.general.getOrdersMeta('orderId-value');
console.log(result);

---

deleteOrdersMeta()

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

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

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

Метод удаляет значение метаданных сборочного задания для переданного ключа. Возможные метаданные: imei, uin, gtin, sgtin Передается только одно значение. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов <strong>получения и удаления метаданных Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 300 запросов | 200 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

Parameters

Parameter	Type	Description
orderId	number	ID сборочного задания
options?	{ key: string; }	Query parameters
options.key?	string	-

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

const result = await sdk.general.deleteOrdersMeta('orderId-value', {});

---

updateMetaSgtin()

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

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

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

Метод закрепляет за сборочным заданием код маркировки Честный знак. <br><br> Закрепить код маркировки можно только, если в метаданных сборочного задания есть поле sgtins, а сборочное задание находится в статусе confirm. <br><br> Получить загруженные маркировки можно в метаданных сборочного задания. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов <strong>закрепления метаданных Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1000 запросов | 60 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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

const result = await sdk.general.updateMetaSgtin('orderId-value', {});

---

updateMetaUin()

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

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

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

Метод обновляет УИН сборочного задания. У одного сборочного задания может быть только один УИН. Добавлять маркировку можно только для сборочных заданий в статусе confirm и доставка которых осуществляется силами WB. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов <strong>закрепления метаданных Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1000 запросов | 60 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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

const result = await sdk.general.updateMetaUin('orderId-value', {});

---

updateMetaImei()

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

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

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

Метод обновляет IMEI сборочного задания. У одного сборочного задания может быть только один IMEI. Добавлять маркировку можно только для сборочных заданий в статусе confirm и доставка которых осуществляется силами WB. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов <strong>закрепления метаданных Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1000 запросов | 60 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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

const result = await sdk.general.updateMetaImei('orderId-value', {});

---

updateMetaGtin()

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

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

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

Метод обновляет GTIN (уникальный ID товара в Беларуси) сборочного задания. У одного сборочного задания может быть только один GTIN. Добавлять маркировку можно только для сборочных заданий в статусе confirm и доставка которых осуществляется силами WB. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов <strong>закрепления метаданных Самовывоз</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1000 запросов | 60 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

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

const result = await sdk.general.updateMetaGtin('orderId-value', {});