Skip to main content
POST
/
v4
/
core
/
companies
/
{companyId}
/
items
Create an item
curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/companies/{companyId}/items \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "data": {
    "platform_id": "string",
    "name": "string",
    "description": "string",
    "code": "string",
    "sku": "string",
    "price": 0,
    "currency_id": "AED",
    "type": "INVENTORY",
    "status": "DRAFT",
    "quantity_on_hand": 0,
    "is_bill_item": false,
    "bill_item": {},
    "is_invoice_item": false,
    "invoice_item": {},
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "variants": [
      {
        "platform_id": "string",
        "parent_id": "string",
        "parent_type": "ACCOUNT",
        "name": "string",
        "sku": "string",
        "price": 0,
        "compare_at_price": 0,
        "currency_id": "AED",
        "status": "ACTIVE",
        "attributes": {}
      }
    ]
  }
}
'
import requests

url = "https://api.integrations.commenda.io/v4/core/companies/{companyId}/items"

payload = { "data": {
        "platform_id": "string",
        "name": "string",
        "description": "string",
        "code": "string",
        "sku": "string",
        "price": 0,
        "currency_id": "AED",
        "type": "INVENTORY",
        "status": "DRAFT",
        "quantity_on_hand": 0,
        "is_bill_item": False,
        "bill_item": {},
        "is_invoice_item": False,
        "invoice_item": {},
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z",
        "variants": [
            {
                "platform_id": "string",
                "parent_id": "string",
                "parent_type": "ACCOUNT",
                "name": "string",
                "sku": "string",
                "price": 0,
                "compare_at_price": 0,
                "currency_id": "AED",
                "status": "ACTIVE",
                "attributes": {}
            }
        ]
    } }
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    data: {
      platform_id: 'string',
      name: 'string',
      description: 'string',
      code: 'string',
      sku: 'string',
      price: 0,
      currency_id: 'AED',
      type: 'INVENTORY',
      status: 'DRAFT',
      quantity_on_hand: 0,
      is_bill_item: false,
      bill_item: {},
      is_invoice_item: false,
      invoice_item: {},
      created_at: '2024-01-01T00:00:00Z',
      updated_at: '2024-01-01T00:00:00Z',
      variants: [
        {
          platform_id: 'string',
          parent_id: 'string',
          parent_type: 'ACCOUNT',
          name: 'string',
          sku: 'string',
          price: 0,
          compare_at_price: 0,
          currency_id: 'AED',
          status: 'ACTIVE',
          attributes: {}
        }
      ]
    }
  })
};

fetch('https://api.integrations.commenda.io/v4/core/companies/{companyId}/items', 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://api.integrations.commenda.io/v4/core/companies/{companyId}/items",
  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([
    'data' => [
        'platform_id' => 'string',
        'name' => 'string',
        'description' => 'string',
        'code' => 'string',
        'sku' => 'string',
        'price' => 0,
        'currency_id' => 'AED',
        'type' => 'INVENTORY',
        'status' => 'DRAFT',
        'quantity_on_hand' => 0,
        'is_bill_item' => false,
        'bill_item' => [
                
        ],
        'is_invoice_item' => false,
        'invoice_item' => [
                
        ],
        'created_at' => '2024-01-01T00:00:00Z',
        'updated_at' => '2024-01-01T00:00:00Z',
        'variants' => [
                [
                                'platform_id' => 'string',
                                'parent_id' => 'string',
                                'parent_type' => 'ACCOUNT',
                                'name' => 'string',
                                'sku' => 'string',
                                'price' => 0,
                                'compare_at_price' => 0,
                                'currency_id' => 'AED',
                                'status' => 'ACTIVE',
                                'attributes' => [
                                                                
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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://api.integrations.commenda.io/v4/core/companies/{companyId}/items"

	payload := strings.NewReader("{\n  \"data\": {\n    \"platform_id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"code\": \"string\",\n    \"sku\": \"string\",\n    \"price\": 0,\n    \"currency_id\": \"AED\",\n    \"type\": \"INVENTORY\",\n    \"status\": \"DRAFT\",\n    \"quantity_on_hand\": 0,\n    \"is_bill_item\": false,\n    \"bill_item\": {},\n    \"is_invoice_item\": false,\n    \"invoice_item\": {},\n    \"created_at\": \"2024-01-01T00:00:00Z\",\n    \"updated_at\": \"2024-01-01T00:00:00Z\",\n    \"variants\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"name\": \"string\",\n        \"sku\": \"string\",\n        \"price\": 0,\n        \"compare_at_price\": 0,\n        \"currency_id\": \"AED\",\n        \"status\": \"ACTIVE\",\n        \"attributes\": {}\n      }\n    ]\n  }\n}")

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

	req.Header.Add("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://api.integrations.commenda.io/v4/core/companies/{companyId}/items")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"platform_id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"code\": \"string\",\n    \"sku\": \"string\",\n    \"price\": 0,\n    \"currency_id\": \"AED\",\n    \"type\": \"INVENTORY\",\n    \"status\": \"DRAFT\",\n    \"quantity_on_hand\": 0,\n    \"is_bill_item\": false,\n    \"bill_item\": {},\n    \"is_invoice_item\": false,\n    \"invoice_item\": {},\n    \"created_at\": \"2024-01-01T00:00:00Z\",\n    \"updated_at\": \"2024-01-01T00:00:00Z\",\n    \"variants\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"name\": \"string\",\n        \"sku\": \"string\",\n        \"price\": 0,\n        \"compare_at_price\": 0,\n        \"currency_id\": \"AED\",\n        \"status\": \"ACTIVE\",\n        \"attributes\": {}\n      }\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/companies/{companyId}/items")

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

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"platform_id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"code\": \"string\",\n    \"sku\": \"string\",\n    \"price\": 0,\n    \"currency_id\": \"AED\",\n    \"type\": \"INVENTORY\",\n    \"status\": \"DRAFT\",\n    \"quantity_on_hand\": 0,\n    \"is_bill_item\": false,\n    \"bill_item\": {},\n    \"is_invoice_item\": false,\n    \"invoice_item\": {},\n    \"created_at\": \"2024-01-01T00:00:00Z\",\n    \"updated_at\": \"2024-01-01T00:00:00Z\",\n    \"variants\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"name\": \"string\",\n        \"sku\": \"string\",\n        \"price\": 0,\n        \"compare_at_price\": 0,\n        \"currency_id\": \"AED\",\n        \"status\": \"ACTIVE\",\n        \"attributes\": {}\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "sync_id": "<string>",
    "data": {
      "rootfi_id": 123,
      "rootfi_created_at": "2023-11-07T05:31:56Z",
      "rootfi_updated_at": "2023-11-07T05:31:56Z",
      "platform_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "code": "<string>",
      "sku": "<string>",
      "price": 123,
      "quantity_on_hand": 123,
      "is_bill_item": true,
      "bill_item": "<unknown>",
      "is_invoice_item": true,
      "invoice_item": "<unknown>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "variants": [
        {
          "rootfi_id": 123,
          "rootfi_created_at": "2023-11-07T05:31:56Z",
          "rootfi_updated_at": "2023-11-07T05:31:56Z",
          "platform_id": "<string>",
          "parent_id": "<string>",
          "name": "<string>",
          "sku": "<string>",
          "price": 123,
          "compare_at_price": 123,
          "attributes": "<unknown>"
        }
      ]
    }
  },
  "request_id": "<string>"
}

Authorizations

​
api_key
string
header
required

Your Commenda Integrations API key, sent in the api_key header.

Path Parameters

​
companyId
integer
required

Commenda company id.

Query Parameters

​
run_async
boolean

Process the write asynchronously. Required when data is an array (batch write).

Body

application/json
​
data
object
required

Response

201 - application/json

The created items record (sync) or a sync id (async).

​
data
object
required
​
request_id
string
required