Wildberries API TypeScript SDK / GeneralModule

Class: GeneralModule

Defined in: modules/general/index.ts:9

Constructors

Constructor

new GeneralModule(client: BaseClient): GeneralModule;

Defined in: modules/general/index.ts:10

Parameters

Parameter	Type
client	BaseClient

Returns

GeneralModule

Methods

ping()

ping(): Promise<{
  TS?: string;
  Status?: "OK";
}>;

Defined in: modules/general/index.ts:24

Проверка подключения

Returns

Promise<{ TS?: string; Status?: "OK"; }>

Успешно

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

---

news()

news(options?: {
  from?: string;
  fromID?: number;
}): Promise<{
  data?: {
     content?: string;
     date?: string;
     header?: string;
     id?: number;
     types?: {
        id?: number;
        name?: string;
     }[];
  }[];
}>;

Defined in: modules/general/index.ts:41

Получение новостей портала продавцов

Parameters

Parameter	Type	Description
options?	{ from?: string; fromID?: number; }	Query parameters
options.from?	string	-
options.fromID?	number	-

Returns

Promise<{ data?: { content?: string; date?: string; header?: string; id?: number; types?: { id?: number; name?: 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.news({});
console.log(result);

---

sellerInfo()

sellerInfo(): Promise<{
  name?: string;
  sid?: string;
  tradeMark?: string;
}>;

Defined in: modules/general/index.ts:57

Получение информации о продавце

Returns

Promise<{ name?: string; sid?: string; tradeMark?: 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.sellerInfo();
console.log(result);