Skip to main content
GET
/
api
/
product-groups
/
{id}
Get ProductGroup by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/product-groups/{id} \
  --header 'x-api-key: <api-key>'
{
  "active": true,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<string>",
  "name": "<string>",
  "order": 123,
  "overviewMarkdown": "<string>",
  "products": [
    {
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "imageUrl": "<string>",
      "name": "<string>",
      "overviewMarkdown": "<string>",
      "productGroup": "<unknown>",
      "productGroupId": "<string>",
      "searchText": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    }
  ],
  "searchText": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The ProductGroup

A product group bundles related products together for catalog organization.

​
active
boolean | null
​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
id
string
​
name
string
​
order
integer<int32>
​
overviewMarkdown
string
​
products
object[]
​
searchText
string
​
updatedOn
string<date-time>
​
uuid
string