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

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 Products

A product represents a purchasable offering on the Kodexa platform.

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
id
string
​
imageUrl
string
​
name
string
​
overviewMarkdown
string
​
productGroup
object

A product group bundles related products together for catalog organization.

​
productGroupId
string | null
​
searchText
string
​
updatedOn
string<date-time>
​
uuid
string