Create Product or Packaging
curl --request POST \
--url https://{base_url_domain}/api/global/v1/inventory/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"resource": {
"type": "Product",
"vendor_sku": "Vendor-SKU-1AD2",
"manufacturer_part_number": "MPN-1AD2",
"external_id": "11-993-9048",
"barcodes": [
"956623520-4",
"O-VS-Oregano-p3"
],
"is_available": true,
"is_visible": true,
"lot_type": {
"type": "LotType",
"id": 4
},
"weight": {
"value": 20
},
"dimensions": {
"length": 8,
"width": 6,
"height": 4
},
"volume": {
"value": 300
},
"inventory": {
"backorders": true,
"dynamic_allocation": true,
"virtual_inventory": "optimistic"
},
"export": {
"description": "Plastic children's toy with steel weights and ball bearings",
"customs_value": {
"amount": 99,
"currency": "USD"
},
"country_of_manufacture": "TW",
"hs_base_code": "8518.30",
"hs_country_extension": [
{
"country_id": "TW",
"extension": "002"
},
{
"country_id": "US",
"extension": "011"
}
]
},
"regulated_goods": {
"regulation": {
"type": "Regulation",
"id": 123
},
"technical_name": "Hydro Polymer Acetylene Coating",
"additional_information": "Flamable Liquid",
"net_weight": {
"value": 20
},
"container_type": "Plastic Box",
"container_meets_hazmat_specs": true,
"regulation_units": 5
},
"packaging": {
"require_packaging": true,
"require_weight_check": true,
"require_confirmation_per_item": true,
"unit_quantity": 1,
"bulk_quantity": 10,
"max_per_package": 15,
"is_ship_separately": true,
"ship_separately_tag": "PVC",
"can_tip": true,
"can_contain_other_items": true,
"is_handling_surcharge": true
},
"custom_fields": [
{
"code": "color",
"value": 13,
"label": "Red and Black"
},
{
"code": "cost_of_goods",
"value": 41.32
},
{
"code": "allow_mailer",
"value": true
}
],
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true
}
}
EOFimport requests
url = "https://{base_url_domain}/api/global/v1/inventory/products"
payload = { "resource": {
"type": "Product",
"vendor_sku": "Vendor-SKU-1AD2",
"manufacturer_part_number": "MPN-1AD2",
"external_id": "11-993-9048",
"barcodes": ["956623520-4", "O-VS-Oregano-p3"],
"is_available": True,
"is_visible": True,
"lot_type": {
"type": "LotType",
"id": 4
},
"weight": { "value": 20 },
"dimensions": {
"length": 8,
"width": 6,
"height": 4
},
"volume": { "value": 300 },
"inventory": {
"backorders": True,
"dynamic_allocation": True,
"virtual_inventory": "optimistic"
},
"export": {
"description": "Plastic children's toy with steel weights and ball bearings",
"customs_value": {
"amount": 99,
"currency": "USD"
},
"country_of_manufacture": "TW",
"hs_base_code": "8518.30",
"hs_country_extension": [
{
"country_id": "TW",
"extension": "002"
},
{
"country_id": "US",
"extension": "011"
}
]
},
"regulated_goods": {
"regulation": {
"type": "Regulation",
"id": 123
},
"technical_name": "Hydro Polymer Acetylene Coating",
"additional_information": "Flamable Liquid",
"net_weight": { "value": 20 },
"container_type": "Plastic Box",
"container_meets_hazmat_specs": True,
"regulation_units": 5
},
"packaging": {
"require_packaging": True,
"require_weight_check": True,
"require_confirmation_per_item": True,
"unit_quantity": 1,
"bulk_quantity": 10,
"max_per_package": 15,
"is_ship_separately": True,
"ship_separately_tag": "PVC",
"can_tip": True,
"can_contain_other_items": True,
"is_handling_surcharge": True
},
"custom_fields": [
{
"code": "color",
"value": 13,
"label": "Red and Black"
},
{
"code": "cost_of_goods",
"value": 41.32
},
{
"code": "allow_mailer",
"value": True
}
],
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": True
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
resource: {
type: 'Product',
vendor_sku: 'Vendor-SKU-1AD2',
manufacturer_part_number: 'MPN-1AD2',
external_id: '11-993-9048',
barcodes: ['956623520-4', 'O-VS-Oregano-p3'],
is_available: true,
is_visible: true,
lot_type: {type: 'LotType', id: 4},
weight: {value: 20},
dimensions: {length: 8, width: 6, height: 4},
volume: {value: 300},
inventory: {backorders: true, dynamic_allocation: true, virtual_inventory: 'optimistic'},
export: {
description: 'Plastic children\'s toy with steel weights and ball bearings',
customs_value: {amount: 99, currency: 'USD'},
country_of_manufacture: 'TW',
hs_base_code: '8518.30',
hs_country_extension: [{country_id: 'TW', extension: '002'}, {country_id: 'US', extension: '011'}]
},
regulated_goods: {
regulation: {type: 'Regulation', id: 123},
technical_name: 'Hydro Polymer Acetylene Coating',
additional_information: 'Flamable Liquid',
net_weight: {value: 20},
container_type: 'Plastic Box',
container_meets_hazmat_specs: true,
regulation_units: 5
},
packaging: {
require_packaging: true,
require_weight_check: true,
require_confirmation_per_item: true,
unit_quantity: 1,
bulk_quantity: 10,
max_per_package: 15,
is_ship_separately: true,
ship_separately_tag: 'PVC',
can_tip: true,
can_contain_other_items: true,
is_handling_surcharge: true
},
custom_fields: [
{code: 'color', value: 13, label: 'Red and Black'},
{code: 'cost_of_goods', value: 41.32},
{code: 'allow_mailer', value: true}
],
sku: 'SKU-1AD',
name: 'Test Product',
is_enabled: true
}
})
};
fetch('https://{base_url_domain}/api/global/v1/inventory/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://{base_url_domain}/api/global/v1/inventory/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([
'resource' => [
'type' => 'Product',
'vendor_sku' => 'Vendor-SKU-1AD2',
'manufacturer_part_number' => 'MPN-1AD2',
'external_id' => '11-993-9048',
'barcodes' => [
'956623520-4',
'O-VS-Oregano-p3'
],
'is_available' => true,
'is_visible' => true,
'lot_type' => [
'type' => 'LotType',
'id' => 4
],
'weight' => [
'value' => 20
],
'dimensions' => [
'length' => 8,
'width' => 6,
'height' => 4
],
'volume' => [
'value' => 300
],
'inventory' => [
'backorders' => true,
'dynamic_allocation' => true,
'virtual_inventory' => 'optimistic'
],
'export' => [
'description' => 'Plastic children\'s toy with steel weights and ball bearings',
'customs_value' => [
'amount' => 99,
'currency' => 'USD'
],
'country_of_manufacture' => 'TW',
'hs_base_code' => '8518.30',
'hs_country_extension' => [
[
'country_id' => 'TW',
'extension' => '002'
],
[
'country_id' => 'US',
'extension' => '011'
]
]
],
'regulated_goods' => [
'regulation' => [
'type' => 'Regulation',
'id' => 123
],
'technical_name' => 'Hydro Polymer Acetylene Coating',
'additional_information' => 'Flamable Liquid',
'net_weight' => [
'value' => 20
],
'container_type' => 'Plastic Box',
'container_meets_hazmat_specs' => true,
'regulation_units' => 5
],
'packaging' => [
'require_packaging' => true,
'require_weight_check' => true,
'require_confirmation_per_item' => true,
'unit_quantity' => 1,
'bulk_quantity' => 10,
'max_per_package' => 15,
'is_ship_separately' => true,
'ship_separately_tag' => 'PVC',
'can_tip' => true,
'can_contain_other_items' => true,
'is_handling_surcharge' => true
],
'custom_fields' => [
[
'code' => 'color',
'value' => 13,
'label' => 'Red and Black'
],
[
'code' => 'cost_of_goods',
'value' => 41.32
],
[
'code' => 'allow_mailer',
'value' => true
]
],
'sku' => 'SKU-1AD',
'name' => 'Test Product',
'is_enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{base_url_domain}/api/global/v1/inventory/products"
payload := strings.NewReader("{\n \"resource\": {\n \"type\": \"Product\",\n \"vendor_sku\": \"Vendor-SKU-1AD2\",\n \"manufacturer_part_number\": \"MPN-1AD2\",\n \"external_id\": \"11-993-9048\",\n \"barcodes\": [\n \"956623520-4\",\n \"O-VS-Oregano-p3\"\n ],\n \"is_available\": true,\n \"is_visible\": true,\n \"lot_type\": {\n \"type\": \"LotType\",\n \"id\": 4\n },\n \"weight\": {\n \"value\": 20\n },\n \"dimensions\": {\n \"length\": 8,\n \"width\": 6,\n \"height\": 4\n },\n \"volume\": {\n \"value\": 300\n },\n \"inventory\": {\n \"backorders\": true,\n \"dynamic_allocation\": true,\n \"virtual_inventory\": \"optimistic\"\n },\n \"export\": {\n \"description\": \"Plastic children's toy with steel weights and ball bearings\",\n \"customs_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"country_of_manufacture\": \"TW\",\n \"hs_base_code\": \"8518.30\",\n \"hs_country_extension\": [\n {\n \"country_id\": \"TW\",\n \"extension\": \"002\"\n },\n {\n \"country_id\": \"US\",\n \"extension\": \"011\"\n }\n ]\n },\n \"regulated_goods\": {\n \"regulation\": {\n \"type\": \"Regulation\",\n \"id\": 123\n },\n \"technical_name\": \"Hydro Polymer Acetylene Coating\",\n \"additional_information\": \"Flamable Liquid\",\n \"net_weight\": {\n \"value\": 20\n },\n \"container_type\": \"Plastic Box\",\n \"container_meets_hazmat_specs\": true,\n \"regulation_units\": 5\n },\n \"packaging\": {\n \"require_packaging\": true,\n \"require_weight_check\": true,\n \"require_confirmation_per_item\": true,\n \"unit_quantity\": 1,\n \"bulk_quantity\": 10,\n \"max_per_package\": 15,\n \"is_ship_separately\": true,\n \"ship_separately_tag\": \"PVC\",\n \"can_tip\": true,\n \"can_contain_other_items\": true,\n \"is_handling_surcharge\": true\n },\n \"custom_fields\": [\n {\n \"code\": \"color\",\n \"value\": 13,\n \"label\": \"Red and Black\"\n },\n {\n \"code\": \"cost_of_goods\",\n \"value\": 41.32\n },\n {\n \"code\": \"allow_mailer\",\n \"value\": true\n }\n ],\n \"sku\": \"SKU-1AD\",\n \"name\": \"Test Product\",\n \"is_enabled\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{base_url_domain}/api/global/v1/inventory/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"resource\": {\n \"type\": \"Product\",\n \"vendor_sku\": \"Vendor-SKU-1AD2\",\n \"manufacturer_part_number\": \"MPN-1AD2\",\n \"external_id\": \"11-993-9048\",\n \"barcodes\": [\n \"956623520-4\",\n \"O-VS-Oregano-p3\"\n ],\n \"is_available\": true,\n \"is_visible\": true,\n \"lot_type\": {\n \"type\": \"LotType\",\n \"id\": 4\n },\n \"weight\": {\n \"value\": 20\n },\n \"dimensions\": {\n \"length\": 8,\n \"width\": 6,\n \"height\": 4\n },\n \"volume\": {\n \"value\": 300\n },\n \"inventory\": {\n \"backorders\": true,\n \"dynamic_allocation\": true,\n \"virtual_inventory\": \"optimistic\"\n },\n \"export\": {\n \"description\": \"Plastic children's toy with steel weights and ball bearings\",\n \"customs_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"country_of_manufacture\": \"TW\",\n \"hs_base_code\": \"8518.30\",\n \"hs_country_extension\": [\n {\n \"country_id\": \"TW\",\n \"extension\": \"002\"\n },\n {\n \"country_id\": \"US\",\n \"extension\": \"011\"\n }\n ]\n },\n \"regulated_goods\": {\n \"regulation\": {\n \"type\": \"Regulation\",\n \"id\": 123\n },\n \"technical_name\": \"Hydro Polymer Acetylene Coating\",\n \"additional_information\": \"Flamable Liquid\",\n \"net_weight\": {\n \"value\": 20\n },\n \"container_type\": \"Plastic Box\",\n \"container_meets_hazmat_specs\": true,\n \"regulation_units\": 5\n },\n \"packaging\": {\n \"require_packaging\": true,\n \"require_weight_check\": true,\n \"require_confirmation_per_item\": true,\n \"unit_quantity\": 1,\n \"bulk_quantity\": 10,\n \"max_per_package\": 15,\n \"is_ship_separately\": true,\n \"ship_separately_tag\": \"PVC\",\n \"can_tip\": true,\n \"can_contain_other_items\": true,\n \"is_handling_surcharge\": true\n },\n \"custom_fields\": [\n {\n \"code\": \"color\",\n \"value\": 13,\n \"label\": \"Red and Black\"\n },\n {\n \"code\": \"cost_of_goods\",\n \"value\": 41.32\n },\n {\n \"code\": \"allow_mailer\",\n \"value\": true\n }\n ],\n \"sku\": \"SKU-1AD\",\n \"name\": \"Test Product\",\n \"is_enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/inventory/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource\": {\n \"type\": \"Product\",\n \"vendor_sku\": \"Vendor-SKU-1AD2\",\n \"manufacturer_part_number\": \"MPN-1AD2\",\n \"external_id\": \"11-993-9048\",\n \"barcodes\": [\n \"956623520-4\",\n \"O-VS-Oregano-p3\"\n ],\n \"is_available\": true,\n \"is_visible\": true,\n \"lot_type\": {\n \"type\": \"LotType\",\n \"id\": 4\n },\n \"weight\": {\n \"value\": 20\n },\n \"dimensions\": {\n \"length\": 8,\n \"width\": 6,\n \"height\": 4\n },\n \"volume\": {\n \"value\": 300\n },\n \"inventory\": {\n \"backorders\": true,\n \"dynamic_allocation\": true,\n \"virtual_inventory\": \"optimistic\"\n },\n \"export\": {\n \"description\": \"Plastic children's toy with steel weights and ball bearings\",\n \"customs_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"country_of_manufacture\": \"TW\",\n \"hs_base_code\": \"8518.30\",\n \"hs_country_extension\": [\n {\n \"country_id\": \"TW\",\n \"extension\": \"002\"\n },\n {\n \"country_id\": \"US\",\n \"extension\": \"011\"\n }\n ]\n },\n \"regulated_goods\": {\n \"regulation\": {\n \"type\": \"Regulation\",\n \"id\": 123\n },\n \"technical_name\": \"Hydro Polymer Acetylene Coating\",\n \"additional_information\": \"Flamable Liquid\",\n \"net_weight\": {\n \"value\": 20\n },\n \"container_type\": \"Plastic Box\",\n \"container_meets_hazmat_specs\": true,\n \"regulation_units\": 5\n },\n \"packaging\": {\n \"require_packaging\": true,\n \"require_weight_check\": true,\n \"require_confirmation_per_item\": true,\n \"unit_quantity\": 1,\n \"bulk_quantity\": 10,\n \"max_per_package\": 15,\n \"is_ship_separately\": true,\n \"ship_separately_tag\": \"PVC\",\n \"can_tip\": true,\n \"can_contain_other_items\": true,\n \"is_handling_surcharge\": true\n },\n \"custom_fields\": [\n {\n \"code\": \"color\",\n \"value\": 13,\n \"label\": \"Red and Black\"\n },\n {\n \"code\": \"cost_of_goods\",\n \"value\": 41.32\n },\n {\n \"code\": \"allow_mailer\",\n \"value\": true\n }\n ],\n \"sku\": \"SKU-1AD\",\n \"name\": \"Test Product\",\n \"is_enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"resource": {
"type": "<string>",
"id": 1
},
"meta": {
"processing_time": 123
}
}{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid."
}
]
}{
"errors": [
{
"type": "unable_to_process",
"message": "There was an error processing the request."
}
]
}Products
Create Product or Packaging
Creates a new Product or PackagingFeature in ShipStream according to the request body.
POST
/
v1
/
inventory
/
products
Create Product or Packaging
curl --request POST \
--url https://{base_url_domain}/api/global/v1/inventory/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"resource": {
"type": "Product",
"vendor_sku": "Vendor-SKU-1AD2",
"manufacturer_part_number": "MPN-1AD2",
"external_id": "11-993-9048",
"barcodes": [
"956623520-4",
"O-VS-Oregano-p3"
],
"is_available": true,
"is_visible": true,
"lot_type": {
"type": "LotType",
"id": 4
},
"weight": {
"value": 20
},
"dimensions": {
"length": 8,
"width": 6,
"height": 4
},
"volume": {
"value": 300
},
"inventory": {
"backorders": true,
"dynamic_allocation": true,
"virtual_inventory": "optimistic"
},
"export": {
"description": "Plastic children's toy with steel weights and ball bearings",
"customs_value": {
"amount": 99,
"currency": "USD"
},
"country_of_manufacture": "TW",
"hs_base_code": "8518.30",
"hs_country_extension": [
{
"country_id": "TW",
"extension": "002"
},
{
"country_id": "US",
"extension": "011"
}
]
},
"regulated_goods": {
"regulation": {
"type": "Regulation",
"id": 123
},
"technical_name": "Hydro Polymer Acetylene Coating",
"additional_information": "Flamable Liquid",
"net_weight": {
"value": 20
},
"container_type": "Plastic Box",
"container_meets_hazmat_specs": true,
"regulation_units": 5
},
"packaging": {
"require_packaging": true,
"require_weight_check": true,
"require_confirmation_per_item": true,
"unit_quantity": 1,
"bulk_quantity": 10,
"max_per_package": 15,
"is_ship_separately": true,
"ship_separately_tag": "PVC",
"can_tip": true,
"can_contain_other_items": true,
"is_handling_surcharge": true
},
"custom_fields": [
{
"code": "color",
"value": 13,
"label": "Red and Black"
},
{
"code": "cost_of_goods",
"value": 41.32
},
{
"code": "allow_mailer",
"value": true
}
],
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true
}
}
EOFimport requests
url = "https://{base_url_domain}/api/global/v1/inventory/products"
payload = { "resource": {
"type": "Product",
"vendor_sku": "Vendor-SKU-1AD2",
"manufacturer_part_number": "MPN-1AD2",
"external_id": "11-993-9048",
"barcodes": ["956623520-4", "O-VS-Oregano-p3"],
"is_available": True,
"is_visible": True,
"lot_type": {
"type": "LotType",
"id": 4
},
"weight": { "value": 20 },
"dimensions": {
"length": 8,
"width": 6,
"height": 4
},
"volume": { "value": 300 },
"inventory": {
"backorders": True,
"dynamic_allocation": True,
"virtual_inventory": "optimistic"
},
"export": {
"description": "Plastic children's toy with steel weights and ball bearings",
"customs_value": {
"amount": 99,
"currency": "USD"
},
"country_of_manufacture": "TW",
"hs_base_code": "8518.30",
"hs_country_extension": [
{
"country_id": "TW",
"extension": "002"
},
{
"country_id": "US",
"extension": "011"
}
]
},
"regulated_goods": {
"regulation": {
"type": "Regulation",
"id": 123
},
"technical_name": "Hydro Polymer Acetylene Coating",
"additional_information": "Flamable Liquid",
"net_weight": { "value": 20 },
"container_type": "Plastic Box",
"container_meets_hazmat_specs": True,
"regulation_units": 5
},
"packaging": {
"require_packaging": True,
"require_weight_check": True,
"require_confirmation_per_item": True,
"unit_quantity": 1,
"bulk_quantity": 10,
"max_per_package": 15,
"is_ship_separately": True,
"ship_separately_tag": "PVC",
"can_tip": True,
"can_contain_other_items": True,
"is_handling_surcharge": True
},
"custom_fields": [
{
"code": "color",
"value": 13,
"label": "Red and Black"
},
{
"code": "cost_of_goods",
"value": 41.32
},
{
"code": "allow_mailer",
"value": True
}
],
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": True
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
resource: {
type: 'Product',
vendor_sku: 'Vendor-SKU-1AD2',
manufacturer_part_number: 'MPN-1AD2',
external_id: '11-993-9048',
barcodes: ['956623520-4', 'O-VS-Oregano-p3'],
is_available: true,
is_visible: true,
lot_type: {type: 'LotType', id: 4},
weight: {value: 20},
dimensions: {length: 8, width: 6, height: 4},
volume: {value: 300},
inventory: {backorders: true, dynamic_allocation: true, virtual_inventory: 'optimistic'},
export: {
description: 'Plastic children\'s toy with steel weights and ball bearings',
customs_value: {amount: 99, currency: 'USD'},
country_of_manufacture: 'TW',
hs_base_code: '8518.30',
hs_country_extension: [{country_id: 'TW', extension: '002'}, {country_id: 'US', extension: '011'}]
},
regulated_goods: {
regulation: {type: 'Regulation', id: 123},
technical_name: 'Hydro Polymer Acetylene Coating',
additional_information: 'Flamable Liquid',
net_weight: {value: 20},
container_type: 'Plastic Box',
container_meets_hazmat_specs: true,
regulation_units: 5
},
packaging: {
require_packaging: true,
require_weight_check: true,
require_confirmation_per_item: true,
unit_quantity: 1,
bulk_quantity: 10,
max_per_package: 15,
is_ship_separately: true,
ship_separately_tag: 'PVC',
can_tip: true,
can_contain_other_items: true,
is_handling_surcharge: true
},
custom_fields: [
{code: 'color', value: 13, label: 'Red and Black'},
{code: 'cost_of_goods', value: 41.32},
{code: 'allow_mailer', value: true}
],
sku: 'SKU-1AD',
name: 'Test Product',
is_enabled: true
}
})
};
fetch('https://{base_url_domain}/api/global/v1/inventory/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://{base_url_domain}/api/global/v1/inventory/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([
'resource' => [
'type' => 'Product',
'vendor_sku' => 'Vendor-SKU-1AD2',
'manufacturer_part_number' => 'MPN-1AD2',
'external_id' => '11-993-9048',
'barcodes' => [
'956623520-4',
'O-VS-Oregano-p3'
],
'is_available' => true,
'is_visible' => true,
'lot_type' => [
'type' => 'LotType',
'id' => 4
],
'weight' => [
'value' => 20
],
'dimensions' => [
'length' => 8,
'width' => 6,
'height' => 4
],
'volume' => [
'value' => 300
],
'inventory' => [
'backorders' => true,
'dynamic_allocation' => true,
'virtual_inventory' => 'optimistic'
],
'export' => [
'description' => 'Plastic children\'s toy with steel weights and ball bearings',
'customs_value' => [
'amount' => 99,
'currency' => 'USD'
],
'country_of_manufacture' => 'TW',
'hs_base_code' => '8518.30',
'hs_country_extension' => [
[
'country_id' => 'TW',
'extension' => '002'
],
[
'country_id' => 'US',
'extension' => '011'
]
]
],
'regulated_goods' => [
'regulation' => [
'type' => 'Regulation',
'id' => 123
],
'technical_name' => 'Hydro Polymer Acetylene Coating',
'additional_information' => 'Flamable Liquid',
'net_weight' => [
'value' => 20
],
'container_type' => 'Plastic Box',
'container_meets_hazmat_specs' => true,
'regulation_units' => 5
],
'packaging' => [
'require_packaging' => true,
'require_weight_check' => true,
'require_confirmation_per_item' => true,
'unit_quantity' => 1,
'bulk_quantity' => 10,
'max_per_package' => 15,
'is_ship_separately' => true,
'ship_separately_tag' => 'PVC',
'can_tip' => true,
'can_contain_other_items' => true,
'is_handling_surcharge' => true
],
'custom_fields' => [
[
'code' => 'color',
'value' => 13,
'label' => 'Red and Black'
],
[
'code' => 'cost_of_goods',
'value' => 41.32
],
[
'code' => 'allow_mailer',
'value' => true
]
],
'sku' => 'SKU-1AD',
'name' => 'Test Product',
'is_enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{base_url_domain}/api/global/v1/inventory/products"
payload := strings.NewReader("{\n \"resource\": {\n \"type\": \"Product\",\n \"vendor_sku\": \"Vendor-SKU-1AD2\",\n \"manufacturer_part_number\": \"MPN-1AD2\",\n \"external_id\": \"11-993-9048\",\n \"barcodes\": [\n \"956623520-4\",\n \"O-VS-Oregano-p3\"\n ],\n \"is_available\": true,\n \"is_visible\": true,\n \"lot_type\": {\n \"type\": \"LotType\",\n \"id\": 4\n },\n \"weight\": {\n \"value\": 20\n },\n \"dimensions\": {\n \"length\": 8,\n \"width\": 6,\n \"height\": 4\n },\n \"volume\": {\n \"value\": 300\n },\n \"inventory\": {\n \"backorders\": true,\n \"dynamic_allocation\": true,\n \"virtual_inventory\": \"optimistic\"\n },\n \"export\": {\n \"description\": \"Plastic children's toy with steel weights and ball bearings\",\n \"customs_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"country_of_manufacture\": \"TW\",\n \"hs_base_code\": \"8518.30\",\n \"hs_country_extension\": [\n {\n \"country_id\": \"TW\",\n \"extension\": \"002\"\n },\n {\n \"country_id\": \"US\",\n \"extension\": \"011\"\n }\n ]\n },\n \"regulated_goods\": {\n \"regulation\": {\n \"type\": \"Regulation\",\n \"id\": 123\n },\n \"technical_name\": \"Hydro Polymer Acetylene Coating\",\n \"additional_information\": \"Flamable Liquid\",\n \"net_weight\": {\n \"value\": 20\n },\n \"container_type\": \"Plastic Box\",\n \"container_meets_hazmat_specs\": true,\n \"regulation_units\": 5\n },\n \"packaging\": {\n \"require_packaging\": true,\n \"require_weight_check\": true,\n \"require_confirmation_per_item\": true,\n \"unit_quantity\": 1,\n \"bulk_quantity\": 10,\n \"max_per_package\": 15,\n \"is_ship_separately\": true,\n \"ship_separately_tag\": \"PVC\",\n \"can_tip\": true,\n \"can_contain_other_items\": true,\n \"is_handling_surcharge\": true\n },\n \"custom_fields\": [\n {\n \"code\": \"color\",\n \"value\": 13,\n \"label\": \"Red and Black\"\n },\n {\n \"code\": \"cost_of_goods\",\n \"value\": 41.32\n },\n {\n \"code\": \"allow_mailer\",\n \"value\": true\n }\n ],\n \"sku\": \"SKU-1AD\",\n \"name\": \"Test Product\",\n \"is_enabled\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{base_url_domain}/api/global/v1/inventory/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"resource\": {\n \"type\": \"Product\",\n \"vendor_sku\": \"Vendor-SKU-1AD2\",\n \"manufacturer_part_number\": \"MPN-1AD2\",\n \"external_id\": \"11-993-9048\",\n \"barcodes\": [\n \"956623520-4\",\n \"O-VS-Oregano-p3\"\n ],\n \"is_available\": true,\n \"is_visible\": true,\n \"lot_type\": {\n \"type\": \"LotType\",\n \"id\": 4\n },\n \"weight\": {\n \"value\": 20\n },\n \"dimensions\": {\n \"length\": 8,\n \"width\": 6,\n \"height\": 4\n },\n \"volume\": {\n \"value\": 300\n },\n \"inventory\": {\n \"backorders\": true,\n \"dynamic_allocation\": true,\n \"virtual_inventory\": \"optimistic\"\n },\n \"export\": {\n \"description\": \"Plastic children's toy with steel weights and ball bearings\",\n \"customs_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"country_of_manufacture\": \"TW\",\n \"hs_base_code\": \"8518.30\",\n \"hs_country_extension\": [\n {\n \"country_id\": \"TW\",\n \"extension\": \"002\"\n },\n {\n \"country_id\": \"US\",\n \"extension\": \"011\"\n }\n ]\n },\n \"regulated_goods\": {\n \"regulation\": {\n \"type\": \"Regulation\",\n \"id\": 123\n },\n \"technical_name\": \"Hydro Polymer Acetylene Coating\",\n \"additional_information\": \"Flamable Liquid\",\n \"net_weight\": {\n \"value\": 20\n },\n \"container_type\": \"Plastic Box\",\n \"container_meets_hazmat_specs\": true,\n \"regulation_units\": 5\n },\n \"packaging\": {\n \"require_packaging\": true,\n \"require_weight_check\": true,\n \"require_confirmation_per_item\": true,\n \"unit_quantity\": 1,\n \"bulk_quantity\": 10,\n \"max_per_package\": 15,\n \"is_ship_separately\": true,\n \"ship_separately_tag\": \"PVC\",\n \"can_tip\": true,\n \"can_contain_other_items\": true,\n \"is_handling_surcharge\": true\n },\n \"custom_fields\": [\n {\n \"code\": \"color\",\n \"value\": 13,\n \"label\": \"Red and Black\"\n },\n {\n \"code\": \"cost_of_goods\",\n \"value\": 41.32\n },\n {\n \"code\": \"allow_mailer\",\n \"value\": true\n }\n ],\n \"sku\": \"SKU-1AD\",\n \"name\": \"Test Product\",\n \"is_enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base_url_domain}/api/global/v1/inventory/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource\": {\n \"type\": \"Product\",\n \"vendor_sku\": \"Vendor-SKU-1AD2\",\n \"manufacturer_part_number\": \"MPN-1AD2\",\n \"external_id\": \"11-993-9048\",\n \"barcodes\": [\n \"956623520-4\",\n \"O-VS-Oregano-p3\"\n ],\n \"is_available\": true,\n \"is_visible\": true,\n \"lot_type\": {\n \"type\": \"LotType\",\n \"id\": 4\n },\n \"weight\": {\n \"value\": 20\n },\n \"dimensions\": {\n \"length\": 8,\n \"width\": 6,\n \"height\": 4\n },\n \"volume\": {\n \"value\": 300\n },\n \"inventory\": {\n \"backorders\": true,\n \"dynamic_allocation\": true,\n \"virtual_inventory\": \"optimistic\"\n },\n \"export\": {\n \"description\": \"Plastic children's toy with steel weights and ball bearings\",\n \"customs_value\": {\n \"amount\": 99,\n \"currency\": \"USD\"\n },\n \"country_of_manufacture\": \"TW\",\n \"hs_base_code\": \"8518.30\",\n \"hs_country_extension\": [\n {\n \"country_id\": \"TW\",\n \"extension\": \"002\"\n },\n {\n \"country_id\": \"US\",\n \"extension\": \"011\"\n }\n ]\n },\n \"regulated_goods\": {\n \"regulation\": {\n \"type\": \"Regulation\",\n \"id\": 123\n },\n \"technical_name\": \"Hydro Polymer Acetylene Coating\",\n \"additional_information\": \"Flamable Liquid\",\n \"net_weight\": {\n \"value\": 20\n },\n \"container_type\": \"Plastic Box\",\n \"container_meets_hazmat_specs\": true,\n \"regulation_units\": 5\n },\n \"packaging\": {\n \"require_packaging\": true,\n \"require_weight_check\": true,\n \"require_confirmation_per_item\": true,\n \"unit_quantity\": 1,\n \"bulk_quantity\": 10,\n \"max_per_package\": 15,\n \"is_ship_separately\": true,\n \"ship_separately_tag\": \"PVC\",\n \"can_tip\": true,\n \"can_contain_other_items\": true,\n \"is_handling_surcharge\": true\n },\n \"custom_fields\": [\n {\n \"code\": \"color\",\n \"value\": 13,\n \"label\": \"Red and Black\"\n },\n {\n \"code\": \"cost_of_goods\",\n \"value\": 41.32\n },\n {\n \"code\": \"allow_mailer\",\n \"value\": true\n }\n ],\n \"sku\": \"SKU-1AD\",\n \"name\": \"Test Product\",\n \"is_enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"resource": {
"type": "<string>",
"id": 1
},
"meta": {
"processing_time": 123
}
}{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid."
}
]
}{
"errors": [
{
"type": "unable_to_process",
"message": "There was an error processing the request."
}
]
}Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Body
application/json
An object conforming to the Inventory Product or PackagingFeature schema to be created.
A Product contains information about a sellable item.
- Product
- PackagingContainer
- PackagingSupplies
- PackagingDataCollection
- PackagingInstruction
- PackagingInfill
Show child attributes
Show child attributes
Was this page helpful?