Create Products - Kodexa Developer Portal

Create Products

curl --request POST \
  --url https://platform.kodexa.ai/api/products \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "<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": [
      {
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "id": "<string>",
        "imageUrl": "<string>",
        "name": "<string>",
        "overviewMarkdown": "<string>",
        "productGroup": null,
        "productGroupId": "<string>",
        "projectTemplates": [
          "<unknown>"
        ],
        "searchText": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      }
    ],
    "searchText": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "productGroupId": "<string>",
  "projectTemplates": [
    "<unknown>"
  ]
}
'

import requests

url = "https://platform.kodexa.ai/api/products"

payload = {
    "description": "<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": [
            {
                "changeSequence": 123,
                "createdOn": "2023-11-07T05:31:56Z",
                "description": "<string>",
                "id": "<string>",
                "imageUrl": "<string>",
                "name": "<string>",
                "overviewMarkdown": "<string>",
                "productGroup": None,
                "productGroupId": "<string>",
                "projectTemplates": ["<unknown>"],
                "searchText": "<string>",
                "updatedOn": "2023-11-07T05:31:56Z",
                "uuid": "<string>"
            }
        ],
        "searchText": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
    },
    "productGroupId": "<string>",
    "projectTemplates": ["<unknown>"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<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: [
        {
          changeSequence: 123,
          createdOn: '2023-11-07T05:31:56Z',
          description: '<string>',
          id: '<string>',
          imageUrl: '<string>',
          name: '<string>',
          overviewMarkdown: '<string>',
          productGroup: null,
          productGroupId: '<string>',
          projectTemplates: ['<unknown>'],
          searchText: '<string>',
          updatedOn: '2023-11-07T05:31:56Z',
          uuid: '<string>'
        }
      ],
      searchText: '<string>',
      updatedOn: '2023-11-07T05:31:56Z',
      uuid: '<string>'
    },
    productGroupId: '<string>',
    projectTemplates: ['<unknown>']
  })
};

fetch('https://platform.kodexa.ai/api/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.kodexa.ai/api/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<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' => [
                [
                                'changeSequence' => 123,
                                'createdOn' => '2023-11-07T05:31:56Z',
                                'description' => '<string>',
                                'id' => '<string>',
                                'imageUrl' => '<string>',
                                'name' => '<string>',
                                'overviewMarkdown' => '<string>',
                                'productGroup' => null,
                                'productGroupId' => '<string>',
                                'projectTemplates' => [
                                                                '<unknown>'
                                ],
                                'searchText' => '<string>',
                                'updatedOn' => '2023-11-07T05:31:56Z',
                                'uuid' => '<string>'
                ]
        ],
        'searchText' => '<string>',
        'updatedOn' => '2023-11-07T05:31:56Z',
        'uuid' => '<string>'
    ],
    'productGroupId' => '<string>',
    'projectTemplates' => [
        '<unknown>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.kodexa.ai/api/products"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"name\": \"<string>\",\n  \"overviewMarkdown\": \"<string>\",\n  \"productGroup\": {\n    \"active\": true,\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"order\": 123,\n    \"overviewMarkdown\": \"<string>\",\n    \"products\": [\n      {\n        \"changeSequence\": 123,\n        \"createdOn\": \"2023-11-07T05:31:56Z\",\n        \"description\": \"<string>\",\n        \"id\": \"<string>\",\n        \"imageUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overviewMarkdown\": \"<string>\",\n        \"productGroup\": null,\n        \"productGroupId\": \"<string>\",\n        \"projectTemplates\": [\n          \"<unknown>\"\n        ],\n        \"searchText\": \"<string>\",\n        \"updatedOn\": \"2023-11-07T05:31:56Z\",\n        \"uuid\": \"<string>\"\n      }\n    ],\n    \"searchText\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"productGroupId\": \"<string>\",\n  \"projectTemplates\": [\n    \"<unknown>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.kodexa.ai/api/products")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"name\": \"<string>\",\n  \"overviewMarkdown\": \"<string>\",\n  \"productGroup\": {\n    \"active\": true,\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"order\": 123,\n    \"overviewMarkdown\": \"<string>\",\n    \"products\": [\n      {\n        \"changeSequence\": 123,\n        \"createdOn\": \"2023-11-07T05:31:56Z\",\n        \"description\": \"<string>\",\n        \"id\": \"<string>\",\n        \"imageUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overviewMarkdown\": \"<string>\",\n        \"productGroup\": null,\n        \"productGroupId\": \"<string>\",\n        \"projectTemplates\": [\n          \"<unknown>\"\n        ],\n        \"searchText\": \"<string>\",\n        \"updatedOn\": \"2023-11-07T05:31:56Z\",\n        \"uuid\": \"<string>\"\n      }\n    ],\n    \"searchText\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"productGroupId\": \"<string>\",\n  \"projectTemplates\": [\n    \"<unknown>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"name\": \"<string>\",\n  \"overviewMarkdown\": \"<string>\",\n  \"productGroup\": {\n    \"active\": true,\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"order\": 123,\n    \"overviewMarkdown\": \"<string>\",\n    \"products\": [\n      {\n        \"changeSequence\": 123,\n        \"createdOn\": \"2023-11-07T05:31:56Z\",\n        \"description\": \"<string>\",\n        \"id\": \"<string>\",\n        \"imageUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overviewMarkdown\": \"<string>\",\n        \"productGroup\": null,\n        \"productGroupId\": \"<string>\",\n        \"projectTemplates\": [\n          \"<unknown>\"\n        ],\n        \"searchText\": \"<string>\",\n        \"updatedOn\": \"2023-11-07T05:31:56Z\",\n        \"uuid\": \"<string>\"\n      }\n    ],\n    \"searchText\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"productGroupId\": \"<string>\",\n  \"projectTemplates\": [\n    \"<unknown>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
  "projectTemplates": [
    "<unknown>"
  ],
  "searchText": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

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 '
{
  "description": "<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": [
      {
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "id": "<string>",
        "imageUrl": "<string>",
        "name": "<string>",
        "overviewMarkdown": "<string>",
        "productGroup": null,
        "productGroupId": "<string>",
        "projectTemplates": [
          "<unknown>"
        ],
        "searchText": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      }
    ],
    "searchText": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "productGroupId": "<string>",
  "projectTemplates": [
    "<unknown>"
  ]
}
'

import requests

url = "https://platform.kodexa.ai/api/products"

payload = {
    "description": "<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": [
            {
                "changeSequence": 123,
                "createdOn": "2023-11-07T05:31:56Z",
                "description": "<string>",
                "id": "<string>",
                "imageUrl": "<string>",
                "name": "<string>",
                "overviewMarkdown": "<string>",
                "productGroup": None,
                "productGroupId": "<string>",
                "projectTemplates": ["<unknown>"],
                "searchText": "<string>",
                "updatedOn": "2023-11-07T05:31:56Z",
                "uuid": "<string>"
            }
        ],
        "searchText": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
    },
    "productGroupId": "<string>",
    "projectTemplates": ["<unknown>"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<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: [
        {
          changeSequence: 123,
          createdOn: '2023-11-07T05:31:56Z',
          description: '<string>',
          id: '<string>',
          imageUrl: '<string>',
          name: '<string>',
          overviewMarkdown: '<string>',
          productGroup: null,
          productGroupId: '<string>',
          projectTemplates: ['<unknown>'],
          searchText: '<string>',
          updatedOn: '2023-11-07T05:31:56Z',
          uuid: '<string>'
        }
      ],
      searchText: '<string>',
      updatedOn: '2023-11-07T05:31:56Z',
      uuid: '<string>'
    },
    productGroupId: '<string>',
    projectTemplates: ['<unknown>']
  })
};

fetch('https://platform.kodexa.ai/api/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.kodexa.ai/api/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<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' => [
                [
                                'changeSequence' => 123,
                                'createdOn' => '2023-11-07T05:31:56Z',
                                'description' => '<string>',
                                'id' => '<string>',
                                'imageUrl' => '<string>',
                                'name' => '<string>',
                                'overviewMarkdown' => '<string>',
                                'productGroup' => null,
                                'productGroupId' => '<string>',
                                'projectTemplates' => [
                                                                '<unknown>'
                                ],
                                'searchText' => '<string>',
                                'updatedOn' => '2023-11-07T05:31:56Z',
                                'uuid' => '<string>'
                ]
        ],
        'searchText' => '<string>',
        'updatedOn' => '2023-11-07T05:31:56Z',
        'uuid' => '<string>'
    ],
    'productGroupId' => '<string>',
    'projectTemplates' => [
        '<unknown>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.kodexa.ai/api/products"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"name\": \"<string>\",\n  \"overviewMarkdown\": \"<string>\",\n  \"productGroup\": {\n    \"active\": true,\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"order\": 123,\n    \"overviewMarkdown\": \"<string>\",\n    \"products\": [\n      {\n        \"changeSequence\": 123,\n        \"createdOn\": \"2023-11-07T05:31:56Z\",\n        \"description\": \"<string>\",\n        \"id\": \"<string>\",\n        \"imageUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overviewMarkdown\": \"<string>\",\n        \"productGroup\": null,\n        \"productGroupId\": \"<string>\",\n        \"projectTemplates\": [\n          \"<unknown>\"\n        ],\n        \"searchText\": \"<string>\",\n        \"updatedOn\": \"2023-11-07T05:31:56Z\",\n        \"uuid\": \"<string>\"\n      }\n    ],\n    \"searchText\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"productGroupId\": \"<string>\",\n  \"projectTemplates\": [\n    \"<unknown>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.kodexa.ai/api/products")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"name\": \"<string>\",\n  \"overviewMarkdown\": \"<string>\",\n  \"productGroup\": {\n    \"active\": true,\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"order\": 123,\n    \"overviewMarkdown\": \"<string>\",\n    \"products\": [\n      {\n        \"changeSequence\": 123,\n        \"createdOn\": \"2023-11-07T05:31:56Z\",\n        \"description\": \"<string>\",\n        \"id\": \"<string>\",\n        \"imageUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overviewMarkdown\": \"<string>\",\n        \"productGroup\": null,\n        \"productGroupId\": \"<string>\",\n        \"projectTemplates\": [\n          \"<unknown>\"\n        ],\n        \"searchText\": \"<string>\",\n        \"updatedOn\": \"2023-11-07T05:31:56Z\",\n        \"uuid\": \"<string>\"\n      }\n    ],\n    \"searchText\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"productGroupId\": \"<string>\",\n  \"projectTemplates\": [\n    \"<unknown>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"name\": \"<string>\",\n  \"overviewMarkdown\": \"<string>\",\n  \"productGroup\": {\n    \"active\": true,\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"order\": 123,\n    \"overviewMarkdown\": \"<string>\",\n    \"products\": [\n      {\n        \"changeSequence\": 123,\n        \"createdOn\": \"2023-11-07T05:31:56Z\",\n        \"description\": \"<string>\",\n        \"id\": \"<string>\",\n        \"imageUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overviewMarkdown\": \"<string>\",\n        \"productGroup\": null,\n        \"productGroupId\": \"<string>\",\n        \"projectTemplates\": [\n          \"<unknown>\"\n        ],\n        \"searchText\": \"<string>\",\n        \"updatedOn\": \"2023-11-07T05:31:56Z\",\n        \"uuid\": \"<string>\"\n      }\n    ],\n    \"searchText\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"productGroupId\": \"<string>\",\n  \"projectTemplates\": [\n    \"<unknown>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
  "projectTemplates": [
    "<unknown>"
  ],
  "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.

description

string

imageUrl

string

name

string

overviewMarkdown

string

productGroup

object | null

A product group bundles related products together for catalog organization.

Show child attributes

productGroupId

string | null

projectTemplates

any[] | null

Response

Created Products

A product represents a purchasable offering on the Kodexa platform.

changeSequence

integer<int32>

required

createdOn

string<date-time>

required

description

string

required

string

required

imageUrl

string

required

name

string

required

overviewMarkdown

string

required

productGroup

object | null

required

A product group bundles related products together for catalog organization.

Show child attributes

productGroupId

string | null

required

projectTemplates

any[] | null

required

searchText

string

required

updatedOn

string<date-time>

required

uuid

string

required