Skip to main content
PUT
/
api
/
products
/
{id}
Update Products
curl --request PUT \
  --url https://platform.kodexa.ai/api/products/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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>"
}
'
import requests

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

payload = {
    "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>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
  })
};

fetch('https://platform.kodexa.ai/api/products/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
  ]),
  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/{id}"

	payload := strings.NewReader("{\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\": {\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\": \"<array>\",\n    \"searchText\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"productGroupId\": \"<string>\",\n  \"searchText\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://platform.kodexa.ai/api/products/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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\": {\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\": \"<array>\",\n    \"searchText\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"productGroupId\": \"<string>\",\n  \"searchText\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\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\": {\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\": \"<array>\",\n    \"searchText\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"productGroupId\": \"<string>\",\n  \"searchText\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\"\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>",
  "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.

Body

application/json

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 | null

A product group bundles related products together for catalog organization.

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

Response

Updated 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 | null

A product group bundles related products together for catalog organization.

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