Client APIs

# Retrieve catalogue of products

Retrieving the catalogue of products allows clients to list all configured products available for issuance.

This page documents the endpoint used to fetch all products: GET /products.

The catalogue of products is returned as an array of product objects in the response, which can be used to list or discover the available products and their codes.

# Pre-requisites

To successfully retrieve the catalogue of products, the following information is required:

  • A valid auth token with read_catalogue scope obtained through an authentication request or reused if a token with sufficient remaining time-to-live is available. See the dedicated authentication and authorization page.

# Request for retrieving the catalogue

This section provides brief instructions on how to retrieve the catalogue. For more detailed technical information, please refer to the OpenAPI specification (opens new window) and the Postman collection (opens new window).

# Request path

GET https://{environment}/v3/products HTTP/1.1

# Request headers

Authorization: Bearer {auth_token}

# DEMO request example

The following example retrieves the client catalogue in the DEMO environment.

GET https://api.demo.uniqrewards.com/v3/products HTTP/1.1

Authorization: Bearer eyJraWQiOiJ3XC9TMTNMZXY0dkRhZDFhTHZPSDF5M0xzQmNhd1lTc3c0SjlQeGorczNuYz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ5amRqeXRjNXp3eTNvdGEzeXplMm5neTBuaiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiY2xpZW50X3YzX2RlbW9cL2lzc3VlX3ZvdWNoZXJzIGNsaWVudF92M19kZW1vXC9yZWFkX2NhdGFsb2d1ZSIsImF1dGhfdGltZSI6MTcwNDA3MDgwMCwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmFwLXNvdXRoZWFzdC0xLmFtYXpvbmF3cy5jb21cL2FwLXNvdXRoZWFzdC0xX1pQQm8xRGZFVCIsImV4cCI6MTcwNDA3NDQwMCwiaWF0IjoxNzA0MDcwODAwLCJ2ZXJzaW9uIjoyLCJqdGkiOiIwYzJjYjIxNC1kOTdjLTQ5NDUtYTc2MS1lZWYzZjJlZDA1ZTEiLCJjbGllbnRfaWQiOiJ5amRqeXRjNXp3eTNvdGEzeXplMm5neTBuaiJ9.lT1Y_nCdCKrYGfK-booBRllLnpb3ekQ0k-nQ6GIWwZrjK6j9pZ9hCn_dbft8u5cGYnxWC4LypE7uNnq329PxXCFVj2YDXt_6i0IR6awTsvimA3wFqt0rb2pVdXKbB2LuP42CiW1NH8kM2_F456_UtYCG5dVbxnANypbdQq4kHEg29HrPuTqtbW6sqXT6b7Xobs2Rjop9AfLSufIGkRuIxKi9MOpkEnZGAhN0zAyOS2eXTFg0QuOIvlL4mwDtDMlIdbHw2NZ0M75rNQa-nzBueg8fcgECNegbJ6_67N26mj3Xbl5k07iMTvs2FQ4VbuvocwS1B5gqJYT9rFxpZOC1mw
Content-Type: application/json

# Retrieve catalogue successful response

A successful response is identified by the 200 OK status code. If any other code is received, the request has failed. See error responses for more information on handling errors.

# Response body

The response body for a successful catalogue retrieval is formatted in JSON and contains the key products, which is an array of product objects.

{
  "request_id": "{request_id}",
  "products": [
    {product_object_1},
    {product_object_2},
    // etc.
  ]
}
  • request_id: The request ID in UUID v4 format, assigned by the API to the request.
  • product_object_#: JSON objects representing each product in the catalogue. The structure of these product objects is detailed on the products and catalogue page.

# DEMO response example

Below is a sample response corresponding to the DEMO request example. This response returns the details of the 4 products of this sample catalogue.

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8

{
  "request_id": "2be96cbc-fbdb-4891-ae2e-3217da96aa52",
  "products": [
    {
      "product_code": "SUV050ECARD03",
      "name": "$50 UNIQGIFT eGift Card",
      "description": "$50 UNIQGIFT eGift Card (UAT Sample)",
      "is_value_based": true,
      "is_open_value": false,
      "is_status_available": true,
      "is_multiple_use": true,
      "currency": "SGD",
      "amount": 5000,
      "quantity": null,
      "expiry_scheme": "1 year from issuance",
      "valid_from": "2023-01-01T00:00:00+08:00",
      "valid_until": null,
      "image": "https://images.qa.uniqgift.com/voucher/750x288/SUV050ECARD03.jpg",
      "terms_and_conditions": "https://www.uniqgiftvoucher.com/terms-conditions/"
    },
    {
      "product_code": "UNIVDYNAMICTEST01",
      "name": "${FV} UNIQGIFT Dynamic Voucher",
      "description": "UNIQGIFT Dynamic Voucher",
      "is_value_based": true,
      "is_open_value": true,
      "is_status_available": true,
      "is_multiple_use": true,
      "currency": "SGD",
      "amount": 0,
      "quantity": null,
      "expiry_scheme": "1 year from issuance",
      "valid_from": "2023-01-01T00:00:00+08:00",
      "valid_until": null,
      "image": "https://images.qa.uniqgift.com/voucher/750x288/UNIVDYNAMICTEST01.jpg",
      "terms_and_conditions": "runs out or expires.\n• This voucher is issued by Option Gift Pte Ltd which owns the registered trademark UNIQGIFT.\n• This voucher must be presented before payment. \n• This voucher cannot be exchanged for cash and any unused balance at expiry will not be refunded. \n• This voucher cannot be replaced if lost, damaged, stolen or expired.\n• Option Gift Pte Ltd reserves the right to vary these terms and conditions at any time without prior notice.\n• Option Gift Pte Ltd shall not be responsible for any issue that arises in connection with the redemption and/or use of this voucher and shall not be responsible or held liable for any loss, injury, damage or harm suffered or incurred by or in connection with the redemption or use of the voucher by any person."
    },
    {
      "product_code": "MAMVDDMMYY01",
      "name": "$10 UNIQGIFT Value Based Test Voucher",
      "description": "UNIQGIFT Value Based Test Voucher",
      "is_value_based": true,
      "is_open_value": false,
      "is_status_available": true,
      "is_multiple_use": true,
      "currency": "SGD",
      "amount": 1000,
      "quantity": null,
      "expiry_scheme": "1 year from issuance",
      "valid_from": "2023-01-01T00:00:00+08:00",
      "valid_until": null,
      "image": "https://images.qa.uniqgift.com/voucher/750x288/MAMVDDMMYY01.jpg",
      "terms_and_conditions": "• This voucher may be used for multiple transactions in denominations of SGD1.00 until it runs out or expires.\n• This voucher is issued by Option Gift Pte Ltd which owns the registered trademark UNIQGIFT.\n• This voucher must be presented before payment.\n• This voucher cannot be exchanged for cash and any unused balance at expiry will not be refunded.\n• This voucher cannot be replaced if lost, damaged, stolen or expired.\n• Option Gift Pte Ltd reserves the right to vary these terms and conditions at any time without prior notice.\n• Option Gift Pte Ltd shall not be responsible for any issue that arises in connection with the redemption and/or use of this voucher and shall not be responsible or held liable for any loss, injury, damage or harm suffered or incurred by or in connection with the redemption or use of the voucher by any person."
    },
    {
      "product_code": "MAMPDDMMYY02",
      "name": "UNIQGIFT Product-Based Test Voucher",
      "description": "UNIQGIFT Product-Based Test Voucher",
      "is_value_based": false,
      "is_open_value": false,
      "is_status_available": true,
      "is_multiple_use": false,
      "currency": "",
      "amount": 1,
      "quantity": null,
      "expiry_scheme": "1 year from issuance",
      "valid_from": "2023-01-01T00:00:00+08:00",
      "valid_until": null,
      "image": "https://images.qa.uniqgift.com/voucher/750x288/MAMPDDMMYY02.jpg",
      "terms_and_conditions": "• voucher is not refundable and shall be forfeited.\n• This voucher is issued by Option Gift Pte Ltd which owns the registered trademark UNIQGIFT.\n• This voucher must be presented before payment.\n• This voucher cannot be exchanged for cash and any unused balance at expiry will not be refunded.\n• This voucher cannot be replaced if lost, damaged, stolen or expired.\n• Option Gift Pte Ltd reserves the right to vary these terms and conditions at any time without prior notice.\n• Option Gift Pte Ltd shall not be responsible for any issue that arises in connection with the redemption and/or use of this voucher and shall not be responsible or held liable for any loss, injury, damage or harm suffered or incurred by or in connection with the redemption or use of the voucher by any person."
    }
  ]
}

← Retrieve product details →