Wildberries API TypeScript SDK / OrdersFbsModule

Class: OrdersFbsModule

Defined in: modules/orders-fbs/index.ts:10

Constructors

Constructor

new OrdersFbsModule(client: BaseClient): OrdersFbsModule;

Defined in: modules/orders-fbs/index.ts:11

Parameters

Parameter	Type
`client`	`BaseClient`

Returns

OrdersFbsModule

Methods

getPassesOffices()

getPassesOffices(): Promise<PassOffice[]>;

Defined in: modules/orders-fbs/index.ts:27

Получить список складов, для которых требуется пропуск

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

Returns

Promise<PassOffice[]>

Успешно

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

passes()

passes(): Promise<Pass[]>;

Defined in: modules/orders-fbs/index.ts:45

Получить список пропусков

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

Returns

Promise<Pass[]>

Успешно

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

createPass()

createPass(data: {
  firstName: string;
  lastName: string;
  carModel: string;
  carNumber: string;
  officeId: number;
}): Promise<{
  id?: number;
}>;

Defined in: modules/orders-fbs/index.ts:64

Создать пропуск

Метод создаёт пропуск продавца с привязкой к складу WB. Пропуск действует 48 часов со времени создания. <div class="description_limit"> Максимум 1 запрос в 10 <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">минут</a> на один аккаунт продавца </div>

Parameters

Parameter	Type	Description
`data`	{ `firstName`: `string`; `lastName`: `string`; `carModel`: `string`; `carNumber`: `string`; `officeId`: `number`; }	Общая длина ФИО ограничена от 6 до 100 символов. В номере машины могут быть только буквы и цифры.
`data.firstName`	`string`	-
`data.lastName`	`string`	-
`data.carModel`	`string`	-
`data.carNumber`	`string`	-
`data.officeId`	`number`	-

Returns

Promise<{ id?: number; }>

Создано

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

updatePass()

updatePass(passId: number, data: {
  firstName: string;
  lastName: string;
  carModel: string;
  carNumber: string;
  officeId: number;
}): Promise<void>;

Defined in: modules/orders-fbs/index.ts:83

Обновить пропуск

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

Parameters

Parameter	Type	Description
`passId`	`number`	ID пропуска
`data`	{ `firstName`: `string`; `lastName`: `string`; `carModel`: `string`; `carNumber`: `string`; `officeId`: `number`; }	Общая длина ФИО ограничена от 6 до 100 символов. В номере машины могут быть только буквы и цифры.
`data.firstName`	`string`	-
`data.lastName`	`string`	-
`data.carModel`	`string`	-
`data.carNumber`	`string`	-
`data.officeId`	`number`	-

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.updatePass('passId-value', {});

deletePass()

deletePass(passId: number): Promise<void>;

Defined in: modules/orders-fbs/index.ts:101

Удалить пропуск

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

Parameters

Parameter	Type	Description
`passId`	`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.deletePass('passId-value');

getOrdersNew()

getOrdersNew(): Promise<{
  orders?: OrderNew[];
}>;

Defined in: modules/orders-fbs/index.ts:119

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

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

Returns

Promise<{ orders?: OrderNew[]; }>

Успешно

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

orders()

orders(options?: {
  limit: number;
  next: number;
  dateFrom?: number;
  dateTo?: number;
}): Promise<{
  next?: number;
  orders?: Order[];
}>;

Defined in: modules/orders-fbs/index.ts:138

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

Метод возвращает информацию о сборочных заданиях без их актуального статуса. Можно получить данные за заданный период, максимум 30 календарных дней одним запросом. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для методов <strong>сборочных заданий, поставок и пропусков FBS</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<{ next?: number; orders?: Order[]; }>

Успешно

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

createOrdersStatu()

createOrdersStatu(data?: {
  orders: number[];
}): Promise<{
  orders?: {
     id?: number;
     supplierStatus?: "new" | "confirm" | "complete" | "cancel";
     wbStatus?:   | "waiting"
        | "sorted"
        | "sold"
        | "canceled"
        | "canceled_by_client"
        | "declined_by_client"
        | "defect"
        | "ready_for_pickup"
        | "postponed_delivery";
  }[];
}>;

Defined in: modules/orders-fbs/index.ts:157

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

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

Parameters

Parameter	Type	Description
`data?`	{ `orders`: `number`[]; }	Request body data
`data.orders?`	`number`[]	-

Returns

Promise<{ orders?: { id?: number; supplierStatus?: "new" | "confirm" | "complete" | "cancel"; wbStatus?: | "waiting" | "sorted" | "sold" | "canceled" | "canceled_by_client" | "declined_by_client" | "defect" | "ready_for_pickup" | "postponed_delivery"; }[]; }>

Успешно

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

getOrdersReshipment()

getOrdersReshipment(): Promise<{
  orders?: {
     supplyID?: unknown;
     orderID?: unknown;
  }[];
}>;

Defined in: modules/orders-fbs/index.ts:175

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

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

Returns

Promise<{ orders?: { supplyID?: unknown; orderID?: unknown; }[]; }>

Успешно

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

updateOrdersCancel()

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

Defined in: modules/orders-fbs/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');

createOrdersSticker()

createOrdersSticker(options?: {
  type: "svg" | "zplv" | "zplh" | "png";
  width: 40 | 58;
  height: 30 | 40;
}, data?: {
  orders?: number[];
}): Promise<{
  stickers?: {
     orderId?: number;
     partA?: string;
     partB?: string;
     barcode?: string;
     file?: string;
  }[];
}>;

Defined in: modules/orders-fbs/index.ts:213

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

Метод возвращает список стикеров для сборочных заданий. Можно получить стикер в форматах: - SVG - ZPLV (вертикальный) - ZPLH (горизонтальный) - PNG Ограничения: - За один запрос можно получить максимум 100 стикеров. - Можно получить стикеры только для сборочных заданий, находящихся на сборке — статус confirm. Доступны размеры: - 580x400 px при width=58&height=40 в запросе - 400x300 px при width=40&height=30 в запросе <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для методов <strong>сборочных заданий, поставок и пропусков FBS</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 300 запросов | 200 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

Parameters

Parameter	Type	Description
`options?`	{ `type`: `"svg"` \| `"zplv"` \| `"zplh"` \| `"png"`; `width`: `40` \| `58`; `height`: `30` \| `40`; }	Query parameters
`options.type?`	`"svg"` \| `"zplv"` \| `"zplh"` \| `"png"`	-
`options.width?`	`40` \| `58`	-
`options.height?`	`30` \| `40`	-
`data?`	{ `orders?`: `number`[]; }	Request body data
`data.orders?`	`number`[]	-

Returns

Promise<{ stickers?: { orderId?: number; partA?: string; partB?: string; barcode?: string; file?: string; }[]; }>

Успешно

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

getOrdersMeta()

getOrdersMeta(orderId: number): Promise<{
  meta?: Meta;
}>;

Defined in: modules/orders-fbs/index.ts:232

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

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

Parameters

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

Returns

Promise<{ meta?: Meta; }>

Успешно

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/orders-fbs/index.ts:251

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

Метод удаляет значение метаданных сборочного задания для переданного ключа. <br><br> Возможные метаданные: - imei — IMEI - uin — УИН - gtin — GTIN - sgtin — код маркировки Можно передать только один ключ. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для всех методов <strong>получения и удаления метаданных FBS</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?: {
  sgtins?: string[];
}): Promise<void>;

Defined in: modules/orders-fbs/index.ts:270

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

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

Parameters

Parameter	Type	Description
`orderId`	`number`	ID сборочного задания
`data?`	{ `sgtins?`: `string`[]; }	Request body data
`data.sgtins?`	`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.updateMetaSgtin('orderId-value', {});

updateMetaUin()

updateMetaUin(orderId: number, data?: {
  uin: string;
}): Promise<void>;

Defined in: modules/orders-fbs/index.ts:289

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

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

Parameters

Parameter	Type	Description
`orderId`	`number`	ID сборочного задания
`data?`	{ `uin`: `string`; }	Request body data
`data.uin?`	`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.updateMetaUin('orderId-value', {});

updateMetaImei()

updateMetaImei(orderId: number, data?: {
  imei: string;
}): Promise<void>;

Defined in: modules/orders-fbs/index.ts:308

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

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

Parameters

Parameter	Type	Description
`orderId`	`number`	ID сборочного задания
`data?`	{ `imei`: `string`; }	Request body data
`data.imei?`	`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.updateMetaImei('orderId-value', {});

updateMetaGtin()

updateMetaGtin(orderId: number, data?: {
  gtin: string;
}): Promise<void>;

Defined in: modules/orders-fbs/index.ts:327

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

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

Parameters

Parameter	Type	Description
`orderId`	`number`	ID сборочного задания
`data?`	{ `gtin`: `string`; }	Request body data
`data.gtin?`	`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.updateMetaGtin('orderId-value', {});

updateMetaExpiration()

updateMetaExpiration(orderId: number, data?: {
  expiration?: string;
}): Promise<void>;

Defined in: modules/orders-fbs/index.ts:346

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

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

Parameters

Parameter	Type	Description
`orderId`	`number`	ID сборочного задания
`data?`	{ `expiration?`: `string`; }	Request body data
`data.expiration?`	`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.updateMetaExpiration('orderId-value', {});

createStickersCrossBorder()

createStickersCrossBorder(data?: {
  orders?: number[];
}): Promise<{
  stickers?: {
     file?: string;
     orderId?: number;
  }[];
}>;

Defined in: modules/orders-fbs/index.ts:365

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

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

Parameters

Parameter	Type	Description
`data?`	{ `orders?`: `number`[]; }	Request body data
`data.orders?`	`number`[]	-

Returns

Promise<{ stickers?: { file?: string; orderId?: number; }[]; }>

Успешно

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

createOrdersExternalSticker()

createOrdersExternalSticker(data?: {
  orders?: number[];
}): Promise<{
  stickers?: {
     orderID?: number;
     url?: string;
     parcelID?: string;
  }[];
}>;

Defined in: modules/orders-fbs/index.ts:384

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

Метод будет отключен 23 октября.

Parameters

Parameter	Type	Description
`data?`	{ `orders?`: `number`[]; }	Request body data
`data.orders?`	`number`[]	-

Returns

Promise<{ stickers?: { orderID?: number; url?: string; parcelID?: string; }[]; }>

Успешно

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

createStatusHistory()

createStatusHistory(data?: {
  orders?: number[];
}): Promise<{
  orders?: {
     deliveryDate?: string;
     statuses?: {
        date?: string;
        code?: string;
     }[];
     orderID?: number;
  }[];
}>;

Defined in: modules/orders-fbs/index.ts:403

История статусов для сборочных заданий кроссбордера

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

Parameters

Parameter	Type	Description
`data?`	{ `orders?`: `number`[]; }	Request body data
`data.orders?`	`number`[]	-

Returns

Promise<{ orders?: { deliveryDate?: string; statuses?: { date?: string; code?: string; }[]; orderID?: number; }[]; }>

Успешно

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

createOrdersClient()

createOrdersClient(data: OrdersRequestAPI): Promise<CrossborderTurkeyClientInfoResp>;

Defined in: modules/orders-fbs/index.ts:422

Заказы с информацией по клиенту

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

Parameters

Parameter	Type	Description
`data`	`OrdersRequestAPI`	Request body data

Returns

Promise<CrossborderTurkeyClientInfoResp>

Успешно

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

supplies()

supplies(options?: {
  limit: number;
  next: number;
}): Promise<{
  next?: number;
  supplies?: Supply[];
}>;

Defined in: modules/orders-fbs/index.ts:441

Получить список поставок

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

Parameters

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

Returns

Promise<{ next?: number; supplies?: Supply[]; }>

Успешно

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

createSupply()

createSupply(data: {
  name?: string;
}): Promise<{
  id?: string;
}>;

Defined in: modules/orders-fbs/index.ts:460

Создать новую поставку

Метод создаёт новую поставку. Ограничения: - Только для сборочных заданий по модели FBS. - При добавлении в поставку все передаваемые сборочные задания в статусе new будут автоматически переведены в статус confirm — на сборке. - Если вы переведёте сборочное задание в статус cancel — отмена продавцом, прикрепленное сборочное задание автоматически удалится из поставки. - Поставку можно собрать только из сборочных заданий (заказов) одного габаритного типа cargoType. Новая поставка не обладает габаритным признаком, она приобретает габаритный признак первого заказа, добавленного в поставку. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для методов <strong>сборочных заданий, поставок и пропусков FBS</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 300 запросов | 200 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

Parameters

Parameter	Type	Description
`data`	{ `name?`: `string`; }	Request body data
`data.name?`	`string`	-

Returns

Promise<{ id?: string; }>

Создано

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

updateSuppliesOrder()

updateSuppliesOrder(supplyId: string, orderId: number): Promise<void>;

Defined in: modules/orders-fbs/index.ts:479

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

Метод добавляет сборочное задание к поставке и переводит его в статус confirm — на сборке. Может перемещать сборочное задание: - между активными поставками. - из закрытой поставки в активную, если сборочное задание требует повторной отгрузки. <div class="description_important"> В пустую поставку можно добавить сборочное задание любого габаритного типа. Поставка приобретает габаритный тип первого добавленного сборочного задания <a href ="./orders-fbs#tag/Postavki-FBS/paths/~1api~1v3~1supplies~1%7BsupplyId%7D/get">из поля</a> <code>cargoType</code>. <br> После этого в поставку можно добавить сборочные задания только того же габаритного типа, что и у поставки. </div> <div class="description_important"> Нельзя добавлять в поставку сборочные задания поступившие на разные склады. </div> <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для метода <strong>добавления сборочных заданий к поставке FBS</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1000 запросов | 60 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

Parameters

Parameter	Type	Description
`supplyId`	`string`	ID поставки
`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.updateSuppliesOrder('supplyId-value', 'orderId-value');

getSupply()

getSupply(supplyId: string): Promise<Supply>;

Defined in: modules/orders-fbs/index.ts:498

Получить информацию о поставке

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

Parameters

Parameter	Type	Description
`supplyId`	`string`	ID поставки

Returns

Promise<Supply>

Успешно

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.getSupply('supplyId-value');
console.log(result);

deleteSupply()

deleteSupply(supplyId: string): Promise<void>;

Defined in: modules/orders-fbs/index.ts:516

Удалить поставку

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

Parameters

Parameter	Type	Description
`supplyId`	`string`	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.deleteSupply('supplyId-value');

getSuppliesOrder()

getSuppliesOrder(supplyId: string): Promise<{
  orders?: SupplyOrder[];
}>;

Defined in: modules/orders-fbs/index.ts:535

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

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

Parameters

Parameter	Type	Description
`supplyId`	`string`	ID поставки

Returns

Promise<{ orders?: SupplyOrder[]; }>

Успешно

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.getSuppliesOrder('supplyId-value');
console.log(result);

updateSuppliesDeliver()

updateSuppliesDeliver(supplyId: string): Promise<void>;

Defined in: modules/orders-fbs/index.ts:553

Передать поставку в доставку

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

Parameters

Parameter	Type	Description
`supplyId`	`string`	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.updateSuppliesDeliver('supplyId-value');

getSuppliesBarcode()

getSuppliesBarcode(supplyId: string, options?: {
  type: "svg" | "zplv" | "zplh" | "png";
}): Promise<{
  barcode?: string;
  file?: string;
}>;

Defined in: modules/orders-fbs/index.ts:573

Получить QR-код поставки

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

Parameters

Parameter	Type	Description
`supplyId`	`string`	ID поставки
`options?`	{ `type`: `"svg"` \| `"zplv"` \| `"zplh"` \| `"png"`; }	Query parameters
`options.type?`	`"svg"` \| `"zplv"` \| `"zplh"` \| `"png"`	-

Returns

Promise<{ barcode?: string; file?: string; }>

Успешно

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.getSuppliesBarcode('supplyId-value', {});
console.log(result);

getSuppliesTrbx()

getSuppliesTrbx(supplyId: string): Promise<{
  trbxes?: SupplyTrbx[];
}>;

Defined in: modules/orders-fbs/index.ts:592

Получить список коробов поставки

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

Parameters

Parameter	Type	Description
`supplyId`	`string`	ID поставки

Returns

Promise<{ trbxes?: SupplyTrbx[]; }>

Успешно

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.getSuppliesTrbx('supplyId-value');
console.log(result);

createSuppliesTrbx()

createSuppliesTrbx(supplyId: string, data?: {
  amount: number;
}): Promise<{
  trbxIds?: string[];
}>;

Defined in: modules/orders-fbs/index.ts:612

Добавить короба к поставке

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

Parameters

Parameter	Type	Description
`supplyId`	`string`	ID поставки
`data?`	{ `amount`: `number`; }	Request body data
`data.amount?`	`number`	-

Returns

Promise<{ trbxIds?: string[]; }>

Создано

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.createSuppliesTrbx('supplyId-value', {});
console.log(result);

deleteSuppliesTrbx()

deleteSuppliesTrbx(supplyId: string, data?: {
  trbxIds: string[];
}): Promise<void>;

Defined in: modules/orders-fbs/index.ts:631

Удалить короба из поставки

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

Parameters

Parameter	Type	Description
`supplyId`	`string`	ID поставки
`data?`	{ `trbxIds`: `string`[]; }	Request body data
`data.trbxIds?`	`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.deleteSuppliesTrbx('supplyId-value', {});

createTrbxSticker()

createTrbxSticker(
   supplyId: string, 
   options?: {
  type: "svg" | "zplv" | "zplh" | "png";
}, 
   data?: {
  trbxIds: string[];
}): Promise<{
  stickers?: TrbxStickers[];
}>;

Defined in: modules/orders-fbs/index.ts:652

Получить стикеры коробов поставки

Метод возвращает QR-стикеры в форматах: - SVG - ZPLV (вертикальный) - ZPLH (горизонтальный) - PNG <br><br> Размер стикеров — 580x400 px. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца для методов <strong>сборочных заданий, поставок и пропусков FBS</strong>: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 300 запросов | 200 миллисекунд | 20 запросов | Один запрос с кодом ответа <code>409</code> учитывается как 5 запросов </div>

Parameters

Parameter	Type	Description
`supplyId`	`string`	ID поставки
`options?`	{ `type`: `"svg"` \| `"zplv"` \| `"zplh"` \| `"png"`; }	Query parameters
`options.type?`	`"svg"` \| `"zplv"` \| `"zplh"` \| `"png"`	-
`data?`	{ `trbxIds`: `string`[]; }	Request body data
`data.trbxIds?`	`string`[]	-

Returns

Promise<{ stickers?: TrbxStickers[]; }>

Успешно

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.createTrbxSticker('supplyId-value', {}, {});
console.log(result);

Class: OrdersFbsModule ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Methods ​

getPassesOffices() ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

passes() ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

createPass() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

updatePass() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

deletePass() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getOrdersNew() ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

orders() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

createOrdersStatu() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getOrdersReshipment() ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

updateOrdersCancel() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Class: OrdersFbsModule

Constructors

Constructor

Parameters

Returns

Methods

getPassesOffices()

Returns

Throws

Throws

Throws

Throws

Example

passes()

Returns

Throws

Throws

Throws

Throws

Example

createPass()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

updatePass()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

deletePass()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getOrdersNew()

Returns

Throws

Throws

Throws

Throws

Example

orders()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

createOrdersStatu()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getOrdersReshipment()

Returns

Throws

Throws

Throws

Throws

Example

updateOrdersCancel()

Parameters

Returns

Throws

Throws

Throws