Skip to main content
POST
/
v1
/
products
/
{entity_id}
Create Product
curl --request POST \
  --url https://api.example.com/v1/products/{entity_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "item_id": "<string>",
  "sku": "<string>",
  "sku_name": "<string>",
  "current_price": 123,
  "unit_cost": 123,
  "product_id": "<string>",
  "product_name": "<string>",
  "product_group": "<string>",
  "manufacturer": "<string>",
  "brand": "<string>",
  "status": "<string>",
  "product_type": "<string>",
  "barcode": "<string>",
  "stock_on_hand": 123,
  "category_1": "<string>",
  "category_2": "<string>",
  "category_3": "<string>",
  "category_4": "<string>",
  "category_5": "<string>",
  "image_url": "<string>",
  "product_url": "<string>",
  "rrp": 123,
  "regular_price": 123,
  "product_created_date": "2023-12-25",
  "price_effective_date": "2023-12-25",
  "cost_effective_date": "2023-12-25",
  "size": "<string>",
  "color": "<string>",
  "uom": "<string>",
  "tax_rate": 123,
  "currency": "<string>"
}
'
import requests

url = "https://api.example.com/v1/products/{entity_id}"

payload = {
    "item_id": "<string>",
    "sku": "<string>",
    "sku_name": "<string>",
    "current_price": 123,
    "unit_cost": 123,
    "product_id": "<string>",
    "product_name": "<string>",
    "product_group": "<string>",
    "manufacturer": "<string>",
    "brand": "<string>",
    "status": "<string>",
    "product_type": "<string>",
    "barcode": "<string>",
    "stock_on_hand": 123,
    "category_1": "<string>",
    "category_2": "<string>",
    "category_3": "<string>",
    "category_4": "<string>",
    "category_5": "<string>",
    "image_url": "<string>",
    "product_url": "<string>",
    "rrp": 123,
    "regular_price": 123,
    "product_created_date": "2023-12-25",
    "price_effective_date": "2023-12-25",
    "cost_effective_date": "2023-12-25",
    "size": "<string>",
    "color": "<string>",
    "uom": "<string>",
    "tax_rate": 123,
    "currency": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    item_id: '<string>',
    sku: '<string>',
    sku_name: '<string>',
    current_price: 123,
    unit_cost: 123,
    product_id: '<string>',
    product_name: '<string>',
    product_group: '<string>',
    manufacturer: '<string>',
    brand: '<string>',
    status: '<string>',
    product_type: '<string>',
    barcode: '<string>',
    stock_on_hand: 123,
    category_1: '<string>',
    category_2: '<string>',
    category_3: '<string>',
    category_4: '<string>',
    category_5: '<string>',
    image_url: '<string>',
    product_url: '<string>',
    rrp: 123,
    regular_price: 123,
    product_created_date: '2023-12-25',
    price_effective_date: '2023-12-25',
    cost_effective_date: '2023-12-25',
    size: '<string>',
    color: '<string>',
    uom: '<string>',
    tax_rate: 123,
    currency: '<string>'
  })
};

fetch('https://api.example.com/v1/products/{entity_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://api.example.com/v1/products/{entity_id}",
  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([
    'item_id' => '<string>',
    'sku' => '<string>',
    'sku_name' => '<string>',
    'current_price' => 123,
    'unit_cost' => 123,
    'product_id' => '<string>',
    'product_name' => '<string>',
    'product_group' => '<string>',
    'manufacturer' => '<string>',
    'brand' => '<string>',
    'status' => '<string>',
    'product_type' => '<string>',
    'barcode' => '<string>',
    'stock_on_hand' => 123,
    'category_1' => '<string>',
    'category_2' => '<string>',
    'category_3' => '<string>',
    'category_4' => '<string>',
    'category_5' => '<string>',
    'image_url' => '<string>',
    'product_url' => '<string>',
    'rrp' => 123,
    'regular_price' => 123,
    'product_created_date' => '2023-12-25',
    'price_effective_date' => '2023-12-25',
    'cost_effective_date' => '2023-12-25',
    'size' => '<string>',
    'color' => '<string>',
    'uom' => '<string>',
    'tax_rate' => 123,
    'currency' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/v1/products/{entity_id}"

	payload := strings.NewReader("{\n  \"item_id\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"sku_name\": \"<string>\",\n  \"current_price\": 123,\n  \"unit_cost\": 123,\n  \"product_id\": \"<string>\",\n  \"product_name\": \"<string>\",\n  \"product_group\": \"<string>\",\n  \"manufacturer\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"status\": \"<string>\",\n  \"product_type\": \"<string>\",\n  \"barcode\": \"<string>\",\n  \"stock_on_hand\": 123,\n  \"category_1\": \"<string>\",\n  \"category_2\": \"<string>\",\n  \"category_3\": \"<string>\",\n  \"category_4\": \"<string>\",\n  \"category_5\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"product_url\": \"<string>\",\n  \"rrp\": 123,\n  \"regular_price\": 123,\n  \"product_created_date\": \"2023-12-25\",\n  \"price_effective_date\": \"2023-12-25\",\n  \"cost_effective_date\": \"2023-12-25\",\n  \"size\": \"<string>\",\n  \"color\": \"<string>\",\n  \"uom\": \"<string>\",\n  \"tax_rate\": 123,\n  \"currency\": \"<string>\"\n}")

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

	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.example.com/v1/products/{entity_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"item_id\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"sku_name\": \"<string>\",\n  \"current_price\": 123,\n  \"unit_cost\": 123,\n  \"product_id\": \"<string>\",\n  \"product_name\": \"<string>\",\n  \"product_group\": \"<string>\",\n  \"manufacturer\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"status\": \"<string>\",\n  \"product_type\": \"<string>\",\n  \"barcode\": \"<string>\",\n  \"stock_on_hand\": 123,\n  \"category_1\": \"<string>\",\n  \"category_2\": \"<string>\",\n  \"category_3\": \"<string>\",\n  \"category_4\": \"<string>\",\n  \"category_5\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"product_url\": \"<string>\",\n  \"rrp\": 123,\n  \"regular_price\": 123,\n  \"product_created_date\": \"2023-12-25\",\n  \"price_effective_date\": \"2023-12-25\",\n  \"cost_effective_date\": \"2023-12-25\",\n  \"size\": \"<string>\",\n  \"color\": \"<string>\",\n  \"uom\": \"<string>\",\n  \"tax_rate\": 123,\n  \"currency\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/products/{entity_id}")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"item_id\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"sku_name\": \"<string>\",\n  \"current_price\": 123,\n  \"unit_cost\": 123,\n  \"product_id\": \"<string>\",\n  \"product_name\": \"<string>\",\n  \"product_group\": \"<string>\",\n  \"manufacturer\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"status\": \"<string>\",\n  \"product_type\": \"<string>\",\n  \"barcode\": \"<string>\",\n  \"stock_on_hand\": 123,\n  \"category_1\": \"<string>\",\n  \"category_2\": \"<string>\",\n  \"category_3\": \"<string>\",\n  \"category_4\": \"<string>\",\n  \"category_5\": \"<string>\",\n  \"image_url\": \"<string>\",\n  \"product_url\": \"<string>\",\n  \"rrp\": 123,\n  \"regular_price\": 123,\n  \"product_created_date\": \"2023-12-25\",\n  \"price_effective_date\": \"2023-12-25\",\n  \"cost_effective_date\": \"2023-12-25\",\n  \"size\": \"<string>\",\n  \"color\": \"<string>\",\n  \"uom\": \"<string>\",\n  \"tax_rate\": 123,\n  \"currency\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "item_id": "<string>",
  "sku": "<string>",
  "product_id": "<string>",
  "product_name": "<string>",
  "product_group": "<string>",
  "manufacturer": "<string>",
  "brand": "<string>",
  "status": "<string>",
  "product_type": "<string>",
  "barcode": "<string>",
  "stock_on_hand": "<string>",
  "category_1": "<string>",
  "category_2": "<string>",
  "category_3": "<string>",
  "category_4": "<string>",
  "category_5": "<string>",
  "image_url": "<string>",
  "product_url": "<string>",
  "rrp": "<string>",
  "regular_price": "<string>",
  "product_created_date": "2023-12-25",
  "price_effective_date": "2023-12-25",
  "cost_effective_date": "2023-12-25",
  "size": "<string>",
  "color": "<string>",
  "uom": "<string>",
  "tax_rate": "<string>",
  "currency": "<string>",
  "sku_name": "<string>",
  "current_price": "<string>",
  "unit_cost": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

​
entity_id
string<uuid>
required

Body

application/json
​
item_id
string
required
​
sku
string
required
​
sku_name
string
required
​
current_price
required
​
unit_cost
required
​
product_id
string | null
​
product_name
string | null
​
product_group
string | null
​
manufacturer
string | null
​
brand
string | null
​
status
string | null
​
product_type
string | null
​
barcode
string | null
​
stock_on_hand
​
category_1
string | null
​
category_2
string | null
​
category_3
string | null
​
category_4
string | null
​
category_5
string | null
​
image_url
string | null
​
product_url
string | null
​
rrp
​
regular_price
​
product_created_date
string<date> | null
​
price_effective_date
string<date> | null
​
cost_effective_date
string<date> | null
​
size
string | null
​
color
string | null
​
uom
string | null
​
tax_rate
​
currency
string | null

Response

Successful Response

​
id
string<uuid>
required
​
item_id
string
required
​
sku
string
required
​
product_id
string | null
​
product_name
string | null
​
product_group
string | null
​
manufacturer
string | null
​
brand
string | null
​
status
string | null
​
product_type
string | null
​
barcode
string | null
​
stock_on_hand
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
category_1
string | null
​
category_2
string | null
​
category_3
string | null
​
category_4
string | null
​
category_5
string | null
​
image_url
string | null
​
product_url
string | null
​
rrp
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
regular_price
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
product_created_date
string<date> | null
​
price_effective_date
string<date> | null
​
cost_effective_date
string<date> | null
​
size
string | null
​
color
string | null
​
uom
string | null
​
tax_rate
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
currency
string | null
​
sku_name
string | null
​
current_price
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
unit_cost
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$