Skip to main content
POST
/
api
/
product-groups
Create ProductGroup
curl --request POST \
  --url https://platform.kodexa.ai/api/product-groups \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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>"
}
'
{
  "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>"
}

Authorizations

​
x-api-key
string
header
required

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

Body

application/json

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

Response

Created 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