Get Products 🆕

Retrieve detailed listings of products, including specifications, pricing, availability, and other critical information necessary for product.

GET /v2/products

Request

HTTP Headers

To use this endpoint, you must include the following headers for authentication and authorization:

Header	Type	Required	Description
x-api-key	String	Yes	API key assigned to your account for service access.
Authorization	String	Yes	Bearer token to authenticate the API request.

Query Parameters

Include the following parameters in the query string to filter product information:

Parameter	Type	Required	Default Value	Description
limit	Integer	No	10	The number of items to be shown per page.
page	Integer	No	1	Page number to retrieve.
sku	String	No	None	Optional filter for listing products by their SKU.

Example Request

GET /v2/products?sku=8PX-UF-Y5U,TTR-WI-YWN HTTP/1.1
Host: api.example.com
Content-Type: application/json
x-api-key: <API_KEY>
Authorization: Bearer <BEARER_ACCESS_TOKEN>

Responses

HTTP Status Codes

Status Code	Description
200	OK
400	Bad Request
500	Internal Server Error

Schema

Property	Type	Nullable	Description
requestId	String	No	Unique identifier assigned to each request for tracking purposes.
data	PaginationResponse	No	Pagination response.

PaginationResponse

Property	Type	Nullable	Description
total	Integer	No	Total number of items available.
page	Integer	No	Current page number.
pageSize	Integer	No	Number of items per page.
totalPage	Integer	No	Total number of pages available.
items	ProductResponse[]	No	List of products on the current page.

ProductResponse

Property	Type	Nullable	Description
sku	String	No	The Stock Keeping Unit identifier for the product.
name	String	No	The name of the product.
brand	String	No	The brand of the product.
brandCategory	String	Yes	The category of the brand.
brandSubCategory	String	Yes	The sub-category of the brand.
types	String[]	No	List of product types.
format	ProductFormat	No	The format of the product.
country	String	Yes	The country for which the product is available.
currency	String	No	The 3-letter currency code (ISO-4217).
imageUrl	String	Yes	The URL of the image representing the product.
prices	PriceResponse[]	No	List of price objects detailing quantity and pricing info.
faceValue	String	No	The face value of the product.
percentageOffFaceValue	String	No	The percentage off the face value of the product.
isInstantDeliverySupported	Boolean	No	Whether the CreateInstantOrder API can be used for instant order and fulfillment.
descriptions	String[]	No	List of product descriptions.
instructions	String[]	No	List of instructions for using the product.
termConditions	String[]	No	List of terms and conditions for the product.

ProductFormat

Value	Type	Description
D	String	Digital
P	String	Physical

PriceResponse

Property	Type	Nullable	Description
price	String	No	The price of the product.
fromQuantity	Integer	No	The minimum quantity for which the price is applicable.
toQuantity	Integer	Yes	The maximum quantity for which the price is applicable (null indicates no limit).

Example 200 OK Response

{
  "requestId": "c4c7b997-79a5-4bde-9f17-47ad7eac9ed4",
  "data": {
    "total": 2,
    "page": 1,
    "pageSize": 10,
    "totalPage": 1,
    "items": [
      {
        "sku": "8PX-UF-Y5U",
        "name": "Apple Gift Card $10 (USA)",
        "brand": "Apple",
        "brandCategory": null,
        "brandSubCategory": null,
        "types": [
          "Gift Cards"
        ],
        "format": "D",
        "country": "US",
        "currency": "USD",
        "imageUrl": "https://example.com/images/products/1045.webp",
        "prices": [
          {
            "price": "9.75",
            "fromQuantity": 1,
            "toQuantity": 99
          },
          {
            "price": "9.5",
            "fromQuantity": 100,
            "toQuantity": null
          }
        ],
        "faceValue": "10.00",
        "percentageOffFaceValue": "2.50",
        "isInstantDeliverySupported": true,
        "descriptions": [],
        "instructions": [],
        "termConditions": []
      },
      {
        "sku": "TTR-WI-YWN",
        "name": "Apple Gift Card $25 (USA)",
        "brand": "Apple",
        "brandCategory": null,
        "brandSubCategory": null,
        "types": [
          "Gift Cards"
        ],
        "format": "D",
        "country": "US",
        "currency": "USD",
        "imageUrl": "https://example.com/images/products/1050.webp",
        "prices": [
          {
            "price": "24.75",
            "fromQuantity": 1,
            "toQuantity": 99
          },
          {
            "price": "24.5",
            "fromQuantity": 100,
            "toQuantity": null
          }
        ],
        "faceValue": "25.00",
        "percentageOffFaceValue": "1.00",
        "isInstantDeliverySupported": true,
        "descriptions": [],
        "instructions": [],
        "termConditions": []
      }
    ]
  }
}