Create product
curl --request POST \
--url https://api.zenskar.com/products \
--header 'Content-Type: application/json' \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"tags": [
"<unknown>"
],
"sku": "<string>",
"parent_link_id": "<string>",
"tax_codes": {},
"is_active": true,
"default_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_attributes": {}
}
'import requests
url = "https://api.zenskar.com/products"
payload = {
"name": "<string>",
"description": "<string>",
"tags": ["<unknown>"],
"sku": "<string>",
"parent_link_id": "<string>",
"tax_codes": {},
"is_active": True,
"default_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_attributes": {}
}
headers = {
"x-api-key": "<api-key>",
"organisation": "<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>',
organisation: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
tags: ['<unknown>'],
sku: '<string>',
parent_link_id: '<string>',
tax_codes: {},
is_active: true,
default_pricing_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
custom_attributes: {}
})
};
fetch('https://api.zenskar.com/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://api.zenskar.com/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([
'name' => '<string>',
'description' => '<string>',
'tags' => [
'<unknown>'
],
'sku' => '<string>',
'parent_link_id' => '<string>',
'tax_codes' => [
],
'is_active' => true,
'default_pricing_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'custom_attributes' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"organisation: <api-key>",
"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://api.zenskar.com/products"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"sku\": \"<string>\",\n \"parent_link_id\": \"<string>\",\n \"tax_codes\": {},\n \"is_active\": true,\n \"default_pricing_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"custom_attributes\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("organisation", "<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.zenskar.com/products")
.header("x-api-key", "<api-key>")
.header("organisation", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"sku\": \"<string>\",\n \"parent_link_id\": \"<string>\",\n \"tax_codes\": {},\n \"is_active\": true,\n \"default_pricing_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"custom_attributes\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zenskar.com/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["organisation"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"sku\": \"<string>\",\n \"parent_link_id\": \"<string>\",\n \"tax_codes\": {},\n \"is_active\": true,\n \"default_pricing_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"custom_attributes\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "product",
"description": "<string>",
"tags": [
"<unknown>"
],
"sku": "<string>",
"parent_link_id": "<string>",
"tax_codes": {},
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"default_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_attributes": {},
"product_category": "group",
"product_type": "time_dependent",
"product_sub_type": "quantity",
"track_usage": true,
"enum_values": [
"<string>"
],
"unit": "<string>",
"entitlements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"entitlement_type": "Feature",
"units": "<string>",
"is_active": true,
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Products
Create product
Creates a new product in the organization.
POST
/
products
Create product
curl --request POST \
--url https://api.zenskar.com/products \
--header 'Content-Type: application/json' \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"tags": [
"<unknown>"
],
"sku": "<string>",
"parent_link_id": "<string>",
"tax_codes": {},
"is_active": true,
"default_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_attributes": {}
}
'import requests
url = "https://api.zenskar.com/products"
payload = {
"name": "<string>",
"description": "<string>",
"tags": ["<unknown>"],
"sku": "<string>",
"parent_link_id": "<string>",
"tax_codes": {},
"is_active": True,
"default_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_attributes": {}
}
headers = {
"x-api-key": "<api-key>",
"organisation": "<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>',
organisation: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
tags: ['<unknown>'],
sku: '<string>',
parent_link_id: '<string>',
tax_codes: {},
is_active: true,
default_pricing_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
custom_attributes: {}
})
};
fetch('https://api.zenskar.com/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://api.zenskar.com/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([
'name' => '<string>',
'description' => '<string>',
'tags' => [
'<unknown>'
],
'sku' => '<string>',
'parent_link_id' => '<string>',
'tax_codes' => [
],
'is_active' => true,
'default_pricing_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'custom_attributes' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"organisation: <api-key>",
"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://api.zenskar.com/products"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"sku\": \"<string>\",\n \"parent_link_id\": \"<string>\",\n \"tax_codes\": {},\n \"is_active\": true,\n \"default_pricing_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"custom_attributes\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("organisation", "<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.zenskar.com/products")
.header("x-api-key", "<api-key>")
.header("organisation", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"sku\": \"<string>\",\n \"parent_link_id\": \"<string>\",\n \"tax_codes\": {},\n \"is_active\": true,\n \"default_pricing_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"custom_attributes\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zenskar.com/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["organisation"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"sku\": \"<string>\",\n \"parent_link_id\": \"<string>\",\n \"tax_codes\": {},\n \"is_active\": true,\n \"default_pricing_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"custom_attributes\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "product",
"description": "<string>",
"tags": [
"<unknown>"
],
"sku": "<string>",
"parent_link_id": "<string>",
"tax_codes": {},
"is_active": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"default_pricing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_attributes": {},
"product_category": "group",
"product_type": "time_dependent",
"product_sub_type": "quantity",
"track_usage": true,
"enum_values": [
"<string>"
],
"unit": "<string>",
"entitlements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"entitlement_type": "Feature",
"units": "<string>",
"is_active": true,
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Headers
Body
application/json
- Create Product Request V1
- Create Product Request V2
Product name
Product Type
Available options:
product, group Product Description
Product Tags
Product SKU
Parent Link ID
Product Tax Codes
Is Active or not
Default Pricing ID
Custom Attributes
Response
Successful Response
Product ID
Product name
Product Type
Available options:
product, group Product Description
Product Tags
Product SKU
Parent Link ID
Product Tax Codes
Is Active or not
Created At
Updated At
Default Pricing ID
Custom Attributes
Product Category
Available options:
group, standalone, bundle Product Type
Available options:
time_dependent, time_independent Product Sub Type
Available options:
quantity, boolean, credits Track Usage or not
Enum Values
Unit
Entitlement
Show child attributes
Show child attributes