Wildberries API TypeScript SDK / RateLimitError

Class: RateLimitError

Defined in: errors/rate-limit-error.ts:25

Rate limit error thrown when API rate limits are exceeded.

This error is thrown for 429 Too Many Requests responses. The SDK's RetryHandler automatically retries rate-limited requests after the specified delay, so consumers typically don't need to handle this error manually.

Example

import { RateLimitError } from 'daytona-wildberries-typescript-sdk';

try {
  await sdk.products.createProduct(data);
} catch (error) {
  if (error instanceof RateLimitError) {
    console.log(`Rate limited. SDK will retry after ${error.retryAfter}ms`);
    // The SDK automatically retries, so you usually don't need to do anything
  }
}

Extends

• WBAPIError

Constructors

Constructor

new RateLimitError(
   message: string, 
   retryAfter: number, 
   response?: unknown, 
   requestId?: string, 
   origin?: string, 
   timestamp?: string): RateLimitError;

Defined in: errors/rate-limit-error.ts:41

Creates a rate limit error

Parameters

Parameter	Type	Default value	Description
message	string	'Rate limit exceeded. The SDK will automatically retry this request.'	Error message (defaults to standard rate limit message)
retryAfter	number	undefined	Milliseconds until retry is allowed
response?	unknown	undefined	API response body if available
requestId?	string	undefined	Correlation ID for debugging
origin?	string	undefined	Origin service identifier from RFC 7807 responses
timestamp?	string	undefined	ISO 8601 timestamp from RFC 7807 responses

Returns

RateLimitError

Overrides

WBAPIError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
statusCode?	readonly	number	HTTP status code if applicable	WBAPIError.statusCode	errors/base-error.ts:25
response?	readonly	unknown	API response body if available	WBAPIError.response	errors/base-error.ts:30
requestId?	readonly	string	Correlation ID for debugging and tracing requests	WBAPIError.requestId	errors/base-error.ts:35
origin?	readonly	string	Origin service identifier from RFC 7807 problem+json responses. Indicates which internal Wildberries service originated the error (e.g., "s2s-api-auth-catalog").	WBAPIError.origin	errors/base-error.ts:43
timestamp?	readonly	string	ISO 8601 timestamp from RFC 7807 problem+json responses. Indicates when the error occurred on the server side (e.g., "2024-09-30T06:52:38Z").	WBAPIError.timestamp	errors/base-error.ts:51
retryAfter	readonly	number	Milliseconds to wait before retrying the request	-	errors/rate-limit-error.ts:29

Methods

getUserMessage()

getUserMessage(): string;

Defined in: errors/rate-limit-error.ts:59

Returns user-friendly error message with retry timing information

Returns

string

Error message with retry delay and automatic handling notice

Overrides

WBAPIError.getUserMessage

---

toJSON()

toJSON(): {
  name: string;
  message: string;
  statusCode: number;
  retryAfter: number;
  response?: unknown;
  requestId?: string;
};

Defined in: errors/rate-limit-error.ts:80

Custom JSON serialization to preserve retryAfter property

Returns

{
  name: string;
  message: string;
  statusCode: number;
  retryAfter: number;
  response?: unknown;
  requestId?: string;
}

Object representation including retryAfter timing

Name	Type	Defined in
name	string	errors/rate-limit-error.ts:81
message	string	errors/rate-limit-error.ts:82
statusCode	number	errors/rate-limit-error.ts:83
retryAfter	number	errors/rate-limit-error.ts:84
response?	unknown	errors/rate-limit-error.ts:85
requestId?	string	errors/rate-limit-error.ts:86

Overrides

WBAPIError.toJSON