GET /api/v1/catalog

Description

Retrieve available rewards from the catalog. Returns a list of all products available for redemption including E-Gift Vouchers, Merchandise, Brand Coupons, and Promotional Offers.

Headers

Authorization

Bearer token received after successful OTP verification.

Parameters

No parameters required.

Example Request

GET /api/v1/catalog
Authorization: Bearer <token>

Example Response

{
  "products": [
    {
      "id": 1,
      "denomination_value": "100",
      "status": 1,
      "qty_trigger_limit": "0",
      "qty": "0",
      "skus": "Bigcity Rewards 100"
    },
    {
      "id": 2,
      "denomination_value": "200",
      "status": 1,
      "qty_trigger_limit": "0",
      "qty": "0",
      "skus": "Bigcity Rewards 200"
    },
    {
      "id": 3,
      "denomination_value": "300",
      "status": 1,
      "qty_trigger_limit": "0",
      "qty": "0",
      "skus": "Bigcity Rewards 300"
    }
  ]
}

Response Fields

products type: array

Array of available reward products.

products[].id type: number

Unique identifier for the reward product.

products[].denomination_value type: string

Point value of the reward denomination.

products[].status type: number

Availability status (1 = active, 0 = inactive).

products[].qty_trigger_limit type: string

Quantity threshold for triggering alerts.

products[].qty type: string

Current available quantity.

products[].skus type: string

SKU name/description of the reward.

Available Reward Types

  • E-Gift Vouchers (EGVs)
  • Merchandise