Skip to content

Wildberries API TypeScript SDK / BudgetExceededError

Class: BudgetExceededError

Defined in: errors/promotion-errors.ts:231

Error thrown when campaign budget is exceeded or insufficient.

This error occurs when:

  • Requested operation would exceed campaign budget
  • Insufficient funds in account for deposit
  • Budget limit reached for billing period

Example

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

try {
  await sdk.promotion.createBudgetDeposit({ sum: 50000 }, { id: 123 });
} catch (error) {
  if (error instanceof BudgetExceededError) {
    console.error(`Budget exceeded: ${error.message}`);
    console.error(`Available: ${error.availableBudget}, Required: ${error.requiredBudget}`);
  }
}

Extends

Constructors

Constructor

ts
new BudgetExceededError(
   message: string, 
   context?: {
  availableBudget?: number;
  requiredBudget?: number;
}, 
   response?: unknown, 
   requestId?: string): BudgetExceededError;

Defined in: errors/promotion-errors.ts:250

Creates a BudgetExceededError

Parameters

ParameterTypeDescription
messagestringError message describing the budget issue
context?{ availableBudget?: number; requiredBudget?: number; }Budget information (available, required)
context.availableBudget?number-
context.requiredBudget?number-
response?unknownAPI response body if available
requestId?stringCorrelation ID for debugging

Returns

BudgetExceededError

Overrides

WBAPIError.constructor

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
<a id="statuscode"></a> statusCode?readonlynumberHTTP status code if applicableWBAPIError.statusCodeerrors/base-error.ts:25
<a id="response"></a> response?readonlyunknownAPI response body if availableWBAPIError.responseerrors/base-error.ts:30
<a id="requestid"></a> requestId?readonlystringCorrelation ID for debugging and tracing requestsWBAPIError.requestIderrors/base-error.ts:35
<a id="availablebudget"></a> availableBudget?readonlynumberAvailable budget amount-errors/promotion-errors.ts:235
<a id="requiredbudget"></a> requiredBudget?readonlynumberRequired budget amount for the operation-errors/promotion-errors.ts:240

Methods

getUserMessage()

ts
getUserMessage(): string;

Defined in: errors/promotion-errors.ts:270

Returns user-friendly error message with budget details

Returns

string

Error message with budget information

Overrides

WBAPIError.getUserMessage


toJSON()

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

Defined in: errors/promotion-errors.ts:310

Custom JSON serialization

Returns

ts
{
  name: string;
  message: string;
  statusCode: number;
  availableBudget?: number;
  requiredBudget?: number;
  response?: unknown;
  requestId?: string;
}
NameTypeDefined in
namestringerrors/promotion-errors.ts:311
messagestringerrors/promotion-errors.ts:312
statusCodenumbererrors/promotion-errors.ts:313
availableBudget?numbererrors/promotion-errors.ts:314
requiredBudget?numbererrors/promotion-errors.ts:315
response?unknownerrors/promotion-errors.ts:316
requestId?stringerrors/promotion-errors.ts:317

Overrides

WBAPIError.toJSON

Made with ❤️ for the Wildberries developer community