Envelope[ProductListResponse]

data object

anyOf

• ProductListResponse
• null

items object[]required

Array [

activationCountries object

anyOf

• string
• null

string

categoryName object

anyOf

• string
• null

string

countryCode object

anyOf

• string
• null

string

fields object

anyOf

• object[]
• null

Array [

keyKeyrequired

label object

anyOf

• string
• null

string

options object

anyOf

• object[]
• null

Array [

labelLabelrequired

price object

anyOf

• number
• null

number

valueValuerequired

]

requiredRequiredrequired

typeTyperequired

validation object

anyOf

• ProductFieldValidation
• null

max object

anyOf

• number
• null

number

message object

anyOf

• string
• null

string

min object

anyOf

• number
• null

number

pattern object

anyOf

• string
• null

string

]

idIdrequired

imageUrl object

Display image for the product. Currently populated only for type="esim" (a flag-CDN image derived from the region's ISO country code); absent for other product types and for eSIM regions without a usable 2-letter ISO code.

anyOf

• string
• null

string

items object[]required

Array [

amountIsQuantityAmountisquantity

true when the item is a quantity-mode DTU (e.g. Telegram Stars, TON). The amount value sent in POST /orders and POST /dtu/validation must then be an integer count of units.

Default value: false

currencyCurrencyrequired

idIdrequired

inStockInstockrequired

isLongOrder object

Whether long orders are supported for this item. When true, you may set isLongOrder=true in POST /orders (shop orders only).

anyOf

• boolean
• null

boolean

maxQuantity object

Maximum allowed quantity. Present only when amountIsQuantity=true.

anyOf

• integer
• null

integer

minQtyToLongOrder object

Minimum quantity for which a long order is allowed. Present only when isLongOrder=true.

anyOf

• integer
• null

integer

minQuantity object

Minimum allowed quantity. Present only when amountIsQuantity=true.

anyOf

• integer
• null

integer

name object

anyOf

• string
• null

string

pricePricerequired

stepQuantity object

Allowed step between quantities. Present only when amountIsQuantity=true.

anyOf

• integer
• null

integer

unitPrice object

Per-unit base price in USD. Present only when amountIsQuantity=true; final price is computed as quantity × unitPrice (plus any tariff markup).

anyOf

• string
• null

string

]

name object

anyOf

• string
• null

string

sectionSectionrequired

subcategoryName object

anyOf

• string
• null

string

typeProductTyperequired

Possible values: [voucher, direct_topup, esim]

]

total object

Total number of products matching the type / search filters. Present only when the request uses the paginated form (limit and/or offset); the legacy unpaginated response keeps its original shape.

anyOf

• integer
• null

integer

errorCode object

anyOf

• string
• null

string

errors object

anyOf

• object[]
• null

Array [

codeFieldErrorCoderequired

Possible values: [MISSING, OUT_OF_RANGE, INVALID_FORMAT, INVALID_VALUE, NOT_ALLOWED, TOO_LONG, TOO_SHORT]

fieldFieldrequired

messageMessagerequired

]

statusTransactionStatusrequired

Possible values: [SUCCESS, IN_PROGRESS, PARTIALLY_COMPLETED, CANCELLED]

statusCodeStatusCoderequired

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]

statusMessageStatusmessagerequired

traceIdTraceidrequired

Envelope[ProductListResponse]

{
  "data": {
    "items": [
      {
        "activationCountries": "string",
        "categoryName": "string",
        "countryCode": "string",
        "fields": [
          {
            "key": "string",
            "label": "string",
            "options": [
              {
                "label": "string",
                "price": 0,
                "value": "string"
              }
            ],
            "required": true,
            "type": "string",
            "validation": {
              "max": 0,
              "message": "string",
              "min": 0,
              "pattern": "string"
            }
          }
        ],
        "id": "string",
        "imageUrl": "string",
        "items": [
          {
            "amountIsQuantity": false,
            "currency": "string",
            "id": "string",
            "inStock": 0,
            "isLongOrder": true,
            "maxQuantity": 0,
            "minQtyToLongOrder": 0,
            "minQuantity": 0,
            "name": "string",
            "price": 0,
            "stepQuantity": 0,
            "unitPrice": "string"
          }
        ],
        "name": "string",
        "section": "string",
        "subcategoryName": "string",
        "type": "voucher"
      }
    ],
    "total": 0
  },
  "errorCode": "string",
  "errors": [
    {
      "code": "MISSING",
      "field": "string",
      "message": "string"
    }
  ],
  "status": "SUCCESS",
  "statusCode": 0,
  "statusMessage": "string",
  "traceId": "string"
}