Doc – Sample Response – www.wupex.com

API Development And
Integration Guid

Sample Response

This is a standard example of the response from the Fetch Product List endpoint (/api/product/merchant/invited/list). It illustrates how data is structured and what each field represents:

https

{
  "pageInfo": {
    "totalPage": 5,
    "totalCount": 95,
    "pageSize": 20,
    "currentPage": 1
  },
  "data": [
    {
      "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.00,
      "discountRate": 0.00,
      "previouslyPurchased": false,
      "favorite": false
    },
    {
      "imageUrl": "https://cdn.wupex.com/img/apple-15.png",
      "productName": "Apple Gift Card $15 (USA)",
      "productCode": "APPLE-USA-15USD",
      "price": 15.00,
      "limit": 0,
      "redeemed": 2,
      "available": 150,
      "enabled": true,
      "productType": "Apple iTunes",
      "balance": 0.00,
      "discountRate": 0.05,
      "previouslyPurchased": true,
      "favorite": true
    }
    // Additional product items here...
  ],
  "status": true
}

Field Breakdown

pageInfo: Contains pagination metadata:
totalPage, totalCount, pageSize, currentPage
data[]: Array of product objects representing each SKU.
imageUrl: URL for product images.
productName: Display name of the gift card.
productCode: SKU used for ordering.
price: Retail price (e.g., 10.00).
limit: Maximum quantity per purchase (0 = no limit).
redeemed: Items already redeemed by user.
available: Number of units available in inventory.
enabled: true = available for purchase.
productType: Category (e.g., Apple iTunes).
balance: Remaining balance (for refillable products).
discountRate: Decimal value (e.g., 0.05 = 5% off).
previouslyPurchased: If user bought this before.
favorite: If marked as a favorite by user.
status: Indicates request success (true) or failure

Integration Tips

Use the data[] array to render product lists, galleries, or catalogs dynamically.
Use productCode directly in /pull-codes to place orders.
Use price, balance, and discountRate for dynamic UI pricing, strikethroughs, and savings display.
Use previouslyPurchased and favorite flags for personalized UI elements like “Recently bought” or “Your Favorites”.
Check enabled and available before rendering “Buy Now” buttons to avoid customer experience issues