Skip to main content

List store items

GET 
/store

Returns active items that are currently available and in stock.

Filtering rules used by backend:

  • item must be is_active = true
  • available_from must be null or in the past
  • available_until must be null or in the future
  • item must be in stock

Request​

Responses​

Successful Response

Response shape​

{
  "items": [
    {
      "id": 12,
      "name": "Amazon INR 100",
      "description": "Gift card",
      "item_type": "voucher",
      "brand_name": "Amazon",
      "image_url": "https://cdn.example.com/amazon-100.png",
      "gem_cost": 150,
      "is_featured": true,
      "available_from": "2026-04-01T00:00:00Z",
      "available_until": null,
      "stock_remaining": 25,
      "in_stock": true
    }
  ]
}

stock_remaining semantics:

  • finite integer for limited stock
  • null when stock is effectively unlimited

cURL example​

curl -X GET "http://localhost:8001/store" \
  -H "x-client-id: <client-id>" \
  -H "x-client-secret: <client-secret>" \
  -H "Authorization: Bearer <access-token>"