Get Products

Description

This services returns a list of available products with optional filtering via query parameters.

---

Request

Endpoint

GET https://<server-url>/api/v4/referencedata/products

Parameters

All parameters for this endpoint are optional and are sent via the query string.

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint making the request. If sent as a header, the name must be Thalamus-Touchpoint.
token	Query / Header	The authentication token for the API. If sent as a header, the name must be Thalamus-Token.
Content-Type	Header	Specifies the content type of the request body. Must be application/json.
marketid	Query	Optional. An integer used to retrieve the tree for a specific market by its ID.
brandfamilyid	Query	Optional. An integer used to retrieve the tree for a specific brand family by its ID.
brandid	Query	Optional. An integer used to retrieve the tree for a specific brand by its ID.
productdid	Query	Optional. An integer used to retrieve the tree for a specific product by its ID.

Full URL Example

http://localhost:8080/thalamus/api/v4/referencedata/products??marketid=1&branfamilyid=1&brandid=1&productid=1&touchpoint=test&token=testtesttesttesttesttesttesttesttesttesttesttesttesttesttesttest

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

A JSON object is returned, representing the hierarchical structure of the requested market data. The structure nests from the top-level market down through brandFamilies, brands, products, and skus.

Field	Type	Description
name	String	The name of the product.
id	Number	The unique identifier for the product.
description	String	Basic description of the product.

JSON

[
  {
    "name": "product_1",
    "id": 1,
    "description": "product_1",
    "sku": "product_1",
    "brand": {
      "name": "Caffeine",
      "id": 5
    }
  },
  {
    "name": "product_2",
    "id": 2,
    "description": "product_2",
    "sku": "product_2",
    "brand": {
      "name": "Caffeine",
      "id": 5
    }
  },
  {
    "name": "product_3",
    "id": 3,
    "description": "product_3",
    "sku": "product_3",
    "brand": {
      "name": "Caffeine",
      "id": 5
    }
  }
]