Skip to content

Get Promotion by ID

The Reloadly Node SDK allows you to fetch details of a specific promotion by its unique ID.

Authentication and token refresh are handled automatically by the SDK.

Path Parameters

ParameterTypeRequiredDescriptionExample
promotionIdIntegerYesThe promotion's identification number.5583

Query Parameters

ParameterTypeDescriptionDefaultExample
languageCodeStringLanguage code (ISO 639-1) for promotion information. Choices: EN, ES, FR, IT, PT, ZH, AR, HI, HT, JA, DE. Default is EN. Case-insensitive.ENEN

Example with Error Handling

ts
import { Reloadly, ReloadlyAPIError } from 'reloadly-node';

const reloadlySDK = new Reloadly({
  clientId: process.env.RELOADLY_CLIENT_ID!,
  clientSecret: process.env.RELOADLY_CLIENT_SECRET!,
  environment: 'sandbox', // or "production"
});

async function main() {
  try {
    const getPromotionById = await reloadlySDK.airtime.getPromotionById({
      path: {
        promotionId: 5583,
      },
      query: {
        languageCode: 'EN',
      },
    });

    console.log('Promotion details:', getPromotionById);
  } catch (error) {
    if (error instanceof ReloadlyAPIError) {
      console.error('Reloadly API Error:', error.message);
      console.error('Error details:', error.data);
    } else {
      console.error('Unexpected error:', error);
    }
  }
}

Response Example

json
{
  "content": {
    "promotionId": 1,
    "operatorId": 129,
    "title": "Tigo El Salvador From 25 Jun 2018 00:00 To 25 July...",
    "title2": "Get 500 MB and 150 minutes for USA or Canada",
    "description": "For top ups of $10 or more, customer...",
    "startDate": "Mon, 25 Jun 2018 06:00:00 +0000",
    "endDate": "Tue, 26 Jun 2018 05:59:00 +0000",
    "denominations": "USD 10 and up",
    "localDenominations": null
  }
}

Notes

  • Works for both sandbox and production environments.
  • Path parameter promotionId is required to identify the promotion.
  • Query parameter languageCode is optional and allows localization of promotion details in ISO 639-1 format (e.g., EN, ES, FR).
  • Token creation, storage, and automatic refresh are handled by the SDK.
  • The SDK automatically applies the correct Accept headers required for Airtime requests.
  • Error handling with ReloadlyAPIError ensures you can capture API-specific issues and unexpected runtime errors.
  • Useful for retrieving detailed information about a specific promotion, including localized title and description, before performing top-ups.