Skip to main content
POST
/
api
/
products
Create Products
curl --request POST \
  --url https://platform.kodexa.ai/api/products \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": true,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "hasQuantity": true,
  "id": "<string>",
  "imageUrl": "<string>",
  "name": "<string>",
  "numberOfCredits": 123,
  "order": 123,
  "overviewMarkdown": "<string>",
  "price": 123,
  "priceId": "<string>",
  "priceSuffix": "<string>",
  "productGroup": {
    "active": true,
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "<string>",
    "name": "<string>",
    "order": 123,
    "overviewMarkdown": "<string>",
    "products": [
      {}
    ],
    "searchText": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "productGroupId": "<string>",
  "projectTemplates": [
    "aSDinaTvuI8gbWludGxpZnk="
  ],
  "promoted": true,
  "searchText": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "active": true,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "hasQuantity": true,
  "id": "<string>",
  "imageUrl": "<string>",
  "name": "<string>",
  "numberOfCredits": 123,
  "order": 123,
  "overviewMarkdown": "<string>",
  "price": 123,
  "priceId": "<string>",
  "priceSuffix": "<string>",
  "productGroup": {
    "active": true,
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "id": "<string>",
    "name": "<string>",
    "order": 123,
    "overviewMarkdown": "<string>",
    "products": [
      {}
    ],
    "searchText": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "productGroupId": "<string>",
  "projectTemplates": [
    "aSDinaTvuI8gbWludGxpZnk="
  ],
  "promoted": true,
  "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 represents a purchasable offering on the Kodexa platform.

​
active
boolean | null
​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
hasQuantity
boolean | null
​
id
string
​
imageUrl
string
​
name
string
​
numberOfCredits
integer<int32>
​
order
integer<int32>
​
overviewMarkdown
string
​
price
number<double>
​
priceId
string
​
priceSuffix
string
​
productGroup
object
​
productGroupId
string | null
​
projectTemplates
string<byte>[]
​
promoted
boolean | null
​
searchText
string
​
updatedOn
string<date-time>
​
uuid
string

Response

Created Products

A product represents a purchasable offering on the Kodexa platform.

​
active
boolean | null
​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
description
string
​
hasQuantity
boolean | null
​
id
string
​
imageUrl
string
​
name
string
​
numberOfCredits
integer<int32>
​
order
integer<int32>
​
overviewMarkdown
string
​
price
number<double>
​
priceId
string
​
priceSuffix
string
​
productGroup
object
​
productGroupId
string | null
​
projectTemplates
string<byte>[]
​
promoted
boolean | null
​
searchText
string
​
updatedOn
string<date-time>
​
uuid
string