Get Catalog item

Description

This service retrieves the full details of a single catalog item, identified by its unique code, for a given mileage activity.

---

Request

Restrictions

This service requires an authenticated user and can only be called after a successful consumer login.

Endpoint

GET https://<server-url>/api/v4/mileage/{activity_code}/catalog/items/{item_code}

Path Parameters

Parameter	Type	Description
activity_code	String	The unique code for the mileage activity (e.g., "ACTIVITYCODE").
item_code	String	The unique code of the catalog item to retrieve.

Parameters

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.
token	Query / Header	The authentication token for the API session. Use Thalamus-Token for the header.

Full URL Example

https://<server-url>/api/v4/mileage/ACTIVITYCODE/catalog/items/ITEMCODE?touchpoint=test&token=...

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

A JSON object is returned containing the full details of the requested catalog item.

Key Item Fields

Field	Type	Description
code	String	The unique code for the catalog item.
name	String	The display name of the item.
itemType	String	The type of item (PHYSICAL_ITEM, VIRTUAL_ITEM, VIRTUAL_VOUCHER_ITEM).
price	Number	The cost of the item in points.
availableStock	Number	The current number of items in stock.
available	Boolean	Indicates if the item is currently available for redemption (considers checkout limit and stock).
beginningDate	Number	The "valid from" date and time (in UNIX Time) set for the item.
expirationDate	Number	The "valid to" date and time (in UNIX Time) set for the item.
checkoutLimitReached	Boolean	Indicates if the current user has reached the checkout limit set for the item.
currentQuota	Number	The quantity available to be checked out by the current user (as per checkout limit).
maxQuotaAvailable	Number	The configured max quantity available for checkout per user.
quotaAvailable	Boolean	Indicates if the current item has checkouts available to the user (as per checkout limit).
maxQuotaAvailableInterval	String	The rate at which the user checkout max quota refreshes. If this attribute shows "Lifetime", the quota does not refresh. The rest of the options include a time interval, such as "Week", "Day", etc.

Example: Physical Item

JSON

{
  "code": "ITEMCODE",
  "name": "Spoon",
  "shortDescription": "Metal spoon",
  "longDescription": "Stainless Metal spoon",
  "tags": "kitchen",
  "smallImageURL": "http://image.com/small.jpg",
  "mediumImageURL": "http://image.com/medium.jpg",
  "largeImageURL": "http://image.com/large.jpg",
  "itemType": "PHYSICAL_ITEM",
  "price": 500,
  "available": true,
  "availableStock": 999
}

Example: Virtual Item

JSON

{
  "code": "ITEMCODE",
  "name": "VirtualItem",
  "shortDescription": "short",
  "longDescription": "long",
  "tags": "123",
  "itemType": "VIRTUAL_ITEM",
  "price": 0,
  "available": true,
  "availableStock": 0
}

Example: Virtual Voucher Item

JSON

{
  "code": "ITEMCODE",
  "name": "VirtualVoucherItem",
  "shortDescription": "A description",
  "longDescription": "Descriptioon",
  "tags": "Tags",
  "itemType": "VIRTUAL_VOUCHER_ITEM",
  "price": 0,
  "available": true,
  "availableStock": 9999,
  "expirationDate": "1494957060000"
}

❌ Unsuccessful Response: 400 Bad Request

Returned if the provided item_code has an invalid format.

JSON

{
  "errors": {
    "item": "InvalidCode"
  }
}

❌ Unsuccessful Response: 404 Not Found

Returned if the specified activity_code or item_code does not exist.

JSON

{
  "errors": {
    "error.message": "NOT_FOUND"
  }
}