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
| Parameter | Type | Description |
|---|---|---|
message | string | Error message describing the budget issue |
context? | { availableBudget?: number; requiredBudget?: number; } | Budget information (available, required) |
context.availableBudget? | number | - |
context.requiredBudget? | number | - |
response? | unknown | API response body if available |
requestId? | string | Correlation ID for debugging |
Returns
BudgetExceededError
Overrides
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
<a id="statuscode"></a> statusCode? | readonly | number | HTTP status code if applicable | WBAPIError.statusCode | errors/base-error.ts:25 |
<a id="response"></a> response? | readonly | unknown | API response body if available | WBAPIError.response | errors/base-error.ts:30 |
<a id="requestid"></a> requestId? | readonly | string | Correlation ID for debugging and tracing requests | WBAPIError.requestId | errors/base-error.ts:35 |
<a id="availablebudget"></a> availableBudget? | readonly | number | Available budget amount | - | errors/promotion-errors.ts:235 |
<a id="requiredbudget"></a> requiredBudget? | readonly | number | Required 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
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;
}| Name | Type | Defined in |
|---|---|---|
name | string | errors/promotion-errors.ts:311 |
message | string | errors/promotion-errors.ts:312 |
statusCode | number | errors/promotion-errors.ts:313 |
availableBudget? | number | errors/promotion-errors.ts:314 |
requiredBudget? | number | errors/promotion-errors.ts:315 |
response? | unknown | errors/promotion-errors.ts:316 |
requestId? | string | errors/promotion-errors.ts:317 |