Product Parameters

API Development And
Integration Guide

When invoking the Fetch Product List endpoint, the JSON response returns a rich set of properties for each product. Understanding these fields helps you render product catalogs, manage inventory, and enhance UX effectively.

Data Object Structure (data[])

Each product object in the data array includes the following fields:

imageUrl (string)
Absolute URL to the product’s image. Use this to display visuals in your UI or marketplace.
productName (string)
Human-readable product name (e.g., “Google Play $10 Gift Card (USA)”).
productCode (string)
Unique SKU used in order requests. Essential for transactions via the /pull-codes endpoint.
price (number)
Retail price of the product in USD or local currency.
limit (integer)
Purchase limit per customer, if any. 0 indicates no limit.
redeemed (integer)
Number of items already redeemed by the customer. Useful for tracking usage and reward limits.
available (integer)
Current stock count available for purchase.
enabled (boolean)
Whether the product is available for purchase; true = available, false = hidden/inactive.
productType (string)
Category of the product (e.g., “Apple iTunes,” “Google Play”).
balance (number)
Current remaining balance for balance-based gift cards (e.g., Visa prepaid cards).
discountRate (number)
Any discount applied to the product expressed as a decimal (e.g., 0.05 for 5% off).
previouslyPurchased (boolean)
Indicates if the customer has ever bought this SKU. Enables personalized product suggestions.
favorite (boolean)
Indicates if the customer has favorited this SKU.

Example Product Object

https

{
  "imageUrl": "https://cdn.wupex.com/img/google-play-10.png",
  "productName": "Google Play $10 Gift Card (USA)",
  "productCode": "GOOGLE-USA-10USD",
  "price": 10.00,
  "limit": 5,
  "redeemed": 0,
  "available": 200,
  "enabled": true,
  "productType": "Google Play",
  "balance": 0.0,
  "discountRate": 0.00,
  "previouslyPurchased": false,
  "favorite": false
}

Usage in Frontend Applications

Product Display: Use imageUrl and productName to visually showcase SKUs in your storefront.
Inventory Tracking: Rely on available and enabled to manage stock visibility.
Pricing Logic: Use price, balance, and discountRate to calculate final pricing or display savings.
Personalization: Use previouslyPurchased and favorite flags to tailor product recommendations to the user.