curl --request POST \
--url https://api.example.com/v1/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sku": "<string>",
"title": "<string>",
"description": "<string>",
"variant_of": "<string>",
"options": {},
"category": "<string>",
"brand": "<string>",
"material": "<string>",
"origin_country": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"hs_codes": {
"export": {},
"import": {}
},
"classification": {
"source": "<string>",
"reviewed": true,
"reviewed_at": 123
},
"compliance": {
"controlled": true,
"eccn": "<string>",
"license": {
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_instruction": "<string>",
"section": "<string>",
"lithium": {
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"barcodes": [
{
"type": "<string>",
"value": "<string>"
}
],
"product_url": "<string>",
"image_url": "<string>",
"external_ids": [
{
"source": "<string>",
"id": "<string>"
}
],
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/products/{id}"
payload = {
"sku": "<string>",
"title": "<string>",
"description": "<string>",
"variant_of": "<string>",
"options": {},
"category": "<string>",
"brand": "<string>",
"material": "<string>",
"origin_country": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"hs_codes": {
"export": {},
"import": {}
},
"classification": {
"source": "<string>",
"reviewed": True,
"reviewed_at": 123
},
"compliance": {
"controlled": True,
"eccn": "<string>",
"license": {
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_instruction": "<string>",
"section": "<string>",
"lithium": {
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"excepted_quantity": True,
"limited_quantity": True,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"barcodes": [
{
"type": "<string>",
"value": "<string>"
}
],
"product_url": "<string>",
"image_url": "<string>",
"external_ids": [
{
"source": "<string>",
"id": "<string>"
}
],
"user_metadata": {}
}
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({
sku: '<string>',
title: '<string>',
description: '<string>',
variant_of: '<string>',
options: {},
category: '<string>',
brand: '<string>',
material: '<string>',
origin_country: '<string>',
manufacturer: {name: '<string>', country: '<string>', mid: '<string>'},
hs_codes: {export: {}, import: {}},
classification: {source: '<string>', reviewed: true, reviewed_at: 123},
compliance: {
controlled: true,
eccn: '<string>',
license: {number: '<string>', expires_on: '2023-12-25'},
regulatory_agency: '<string>',
regulatory_program: '<string>',
regulatory_category_code: '<string>',
certification: {type: '<string>', reference: '<string>'}
},
dangerous_goods: {
class: '<string>',
un_number: '<string>',
proper_shipping_name: '<string>',
packing_instruction: '<string>',
section: '<string>',
lithium: {watt_hours: 123, lithium_grams: 123, cells: 123},
excepted_quantity: true,
limited_quantity: true,
emergency_contact: {name: '<string>', phone: '<string>'},
declaration_document: '<string>'
},
barcodes: [{type: '<string>', value: '<string>'}],
product_url: '<string>',
image_url: '<string>',
external_ids: [{source: '<string>', id: '<string>'}],
user_metadata: {}
})
};
fetch('https://api.example.com/v1/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://api.example.com/v1/products/{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([
'sku' => '<string>',
'title' => '<string>',
'description' => '<string>',
'variant_of' => '<string>',
'options' => [
],
'category' => '<string>',
'brand' => '<string>',
'material' => '<string>',
'origin_country' => '<string>',
'manufacturer' => [
'name' => '<string>',
'country' => '<string>',
'mid' => '<string>'
],
'hs_codes' => [
'export' => [
],
'import' => [
]
],
'classification' => [
'source' => '<string>',
'reviewed' => true,
'reviewed_at' => 123
],
'compliance' => [
'controlled' => true,
'eccn' => '<string>',
'license' => [
'number' => '<string>',
'expires_on' => '2023-12-25'
],
'regulatory_agency' => '<string>',
'regulatory_program' => '<string>',
'regulatory_category_code' => '<string>',
'certification' => [
'type' => '<string>',
'reference' => '<string>'
]
],
'dangerous_goods' => [
'class' => '<string>',
'un_number' => '<string>',
'proper_shipping_name' => '<string>',
'packing_instruction' => '<string>',
'section' => '<string>',
'lithium' => [
'watt_hours' => 123,
'lithium_grams' => 123,
'cells' => 123
],
'excepted_quantity' => true,
'limited_quantity' => true,
'emergency_contact' => [
'name' => '<string>',
'phone' => '<string>'
],
'declaration_document' => '<string>'
],
'barcodes' => [
[
'type' => '<string>',
'value' => '<string>'
]
],
'product_url' => '<string>',
'image_url' => '<string>',
'external_ids' => [
[
'source' => '<string>',
'id' => '<string>'
]
],
'user_metadata' => [
]
]),
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://api.example.com/v1/products/{id}"
payload := strings.NewReader("{\n \"sku\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"variant_of\": \"<string>\",\n \"options\": {},\n \"category\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"hs_codes\": {\n \"export\": {},\n \"import\": {}\n },\n \"classification\": {\n \"source\": \"<string>\",\n \"reviewed\": true,\n \"reviewed_at\": 123\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"barcodes\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"external_ids\": [\n {\n \"source\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"user_metadata\": {}\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://api.example.com/v1/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sku\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"variant_of\": \"<string>\",\n \"options\": {},\n \"category\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"hs_codes\": {\n \"export\": {},\n \"import\": {}\n },\n \"classification\": {\n \"source\": \"<string>\",\n \"reviewed\": true,\n \"reviewed_at\": 123\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"barcodes\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"external_ids\": [\n {\n \"source\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/products/{id}")
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 \"sku\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"variant_of\": \"<string>\",\n \"options\": {},\n \"category\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"hs_codes\": {\n \"export\": {},\n \"import\": {}\n },\n \"classification\": {\n \"source\": \"<string>\",\n \"reviewed\": true,\n \"reviewed_at\": 123\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"barcodes\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"external_ids\": [\n {\n \"source\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "prod_1Q2w3E4r",
"object": "product",
"livemode": true,
"created": 123,
"status": "active",
"sku": "<string>",
"updated": 123,
"title": "<string>",
"description": "<string>",
"variant_of": "<string>",
"options": {},
"category": "<string>",
"brand": "<string>",
"material": "<string>",
"origin_country": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"unit_value": {
"amount": 123,
"currency": "usd"
},
"unit_net_weight": {
"value": 123,
"unit": "g"
},
"unit_gross_weight": {
"value": 123,
"unit": "g"
},
"unit_dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
},
"hs_codes": {
"export": {},
"import": {}
},
"classification": {
"source": "<string>",
"reviewed": true,
"reviewed_at": 123
},
"compliance": {
"controlled": true,
"control_type": "dual_use",
"eccn": "<string>",
"license": {
"type": "export",
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_group": "I",
"packing_instruction": "<string>",
"section": "<string>",
"quantity": {
"value": 123,
"unit": "g"
},
"lithium": {
"type": "ion",
"configuration": "alone",
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"accessibility": "accessible",
"transport_mode": "air",
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"barcodes": [
{
"type": "<string>",
"value": "<string>"
}
],
"product_url": "<string>",
"image_url": "<string>",
"external_ids": [
{
"source": "<string>",
"id": "<string>"
}
],
"restrictions": [
{
"country": "<string>",
"level": "prohibited",
"agency": "<string>",
"code": "<string>",
"message": "<string>",
"license_types": [
"<string>"
],
"documents_required": [
"<string>"
]
}
],
"version": 123,
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}Update a Product
curl --request POST \
--url https://api.example.com/v1/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sku": "<string>",
"title": "<string>",
"description": "<string>",
"variant_of": "<string>",
"options": {},
"category": "<string>",
"brand": "<string>",
"material": "<string>",
"origin_country": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"hs_codes": {
"export": {},
"import": {}
},
"classification": {
"source": "<string>",
"reviewed": true,
"reviewed_at": 123
},
"compliance": {
"controlled": true,
"eccn": "<string>",
"license": {
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_instruction": "<string>",
"section": "<string>",
"lithium": {
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"barcodes": [
{
"type": "<string>",
"value": "<string>"
}
],
"product_url": "<string>",
"image_url": "<string>",
"external_ids": [
{
"source": "<string>",
"id": "<string>"
}
],
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/products/{id}"
payload = {
"sku": "<string>",
"title": "<string>",
"description": "<string>",
"variant_of": "<string>",
"options": {},
"category": "<string>",
"brand": "<string>",
"material": "<string>",
"origin_country": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"hs_codes": {
"export": {},
"import": {}
},
"classification": {
"source": "<string>",
"reviewed": True,
"reviewed_at": 123
},
"compliance": {
"controlled": True,
"eccn": "<string>",
"license": {
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_instruction": "<string>",
"section": "<string>",
"lithium": {
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"excepted_quantity": True,
"limited_quantity": True,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"barcodes": [
{
"type": "<string>",
"value": "<string>"
}
],
"product_url": "<string>",
"image_url": "<string>",
"external_ids": [
{
"source": "<string>",
"id": "<string>"
}
],
"user_metadata": {}
}
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({
sku: '<string>',
title: '<string>',
description: '<string>',
variant_of: '<string>',
options: {},
category: '<string>',
brand: '<string>',
material: '<string>',
origin_country: '<string>',
manufacturer: {name: '<string>', country: '<string>', mid: '<string>'},
hs_codes: {export: {}, import: {}},
classification: {source: '<string>', reviewed: true, reviewed_at: 123},
compliance: {
controlled: true,
eccn: '<string>',
license: {number: '<string>', expires_on: '2023-12-25'},
regulatory_agency: '<string>',
regulatory_program: '<string>',
regulatory_category_code: '<string>',
certification: {type: '<string>', reference: '<string>'}
},
dangerous_goods: {
class: '<string>',
un_number: '<string>',
proper_shipping_name: '<string>',
packing_instruction: '<string>',
section: '<string>',
lithium: {watt_hours: 123, lithium_grams: 123, cells: 123},
excepted_quantity: true,
limited_quantity: true,
emergency_contact: {name: '<string>', phone: '<string>'},
declaration_document: '<string>'
},
barcodes: [{type: '<string>', value: '<string>'}],
product_url: '<string>',
image_url: '<string>',
external_ids: [{source: '<string>', id: '<string>'}],
user_metadata: {}
})
};
fetch('https://api.example.com/v1/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://api.example.com/v1/products/{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([
'sku' => '<string>',
'title' => '<string>',
'description' => '<string>',
'variant_of' => '<string>',
'options' => [
],
'category' => '<string>',
'brand' => '<string>',
'material' => '<string>',
'origin_country' => '<string>',
'manufacturer' => [
'name' => '<string>',
'country' => '<string>',
'mid' => '<string>'
],
'hs_codes' => [
'export' => [
],
'import' => [
]
],
'classification' => [
'source' => '<string>',
'reviewed' => true,
'reviewed_at' => 123
],
'compliance' => [
'controlled' => true,
'eccn' => '<string>',
'license' => [
'number' => '<string>',
'expires_on' => '2023-12-25'
],
'regulatory_agency' => '<string>',
'regulatory_program' => '<string>',
'regulatory_category_code' => '<string>',
'certification' => [
'type' => '<string>',
'reference' => '<string>'
]
],
'dangerous_goods' => [
'class' => '<string>',
'un_number' => '<string>',
'proper_shipping_name' => '<string>',
'packing_instruction' => '<string>',
'section' => '<string>',
'lithium' => [
'watt_hours' => 123,
'lithium_grams' => 123,
'cells' => 123
],
'excepted_quantity' => true,
'limited_quantity' => true,
'emergency_contact' => [
'name' => '<string>',
'phone' => '<string>'
],
'declaration_document' => '<string>'
],
'barcodes' => [
[
'type' => '<string>',
'value' => '<string>'
]
],
'product_url' => '<string>',
'image_url' => '<string>',
'external_ids' => [
[
'source' => '<string>',
'id' => '<string>'
]
],
'user_metadata' => [
]
]),
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://api.example.com/v1/products/{id}"
payload := strings.NewReader("{\n \"sku\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"variant_of\": \"<string>\",\n \"options\": {},\n \"category\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"hs_codes\": {\n \"export\": {},\n \"import\": {}\n },\n \"classification\": {\n \"source\": \"<string>\",\n \"reviewed\": true,\n \"reviewed_at\": 123\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"barcodes\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"external_ids\": [\n {\n \"source\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"user_metadata\": {}\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://api.example.com/v1/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sku\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"variant_of\": \"<string>\",\n \"options\": {},\n \"category\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"hs_codes\": {\n \"export\": {},\n \"import\": {}\n },\n \"classification\": {\n \"source\": \"<string>\",\n \"reviewed\": true,\n \"reviewed_at\": 123\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"barcodes\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"external_ids\": [\n {\n \"source\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/products/{id}")
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 \"sku\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"variant_of\": \"<string>\",\n \"options\": {},\n \"category\": \"<string>\",\n \"brand\": \"<string>\",\n \"material\": \"<string>\",\n \"origin_country\": \"<string>\",\n \"manufacturer\": {\n \"name\": \"<string>\",\n \"country\": \"<string>\",\n \"mid\": \"<string>\"\n },\n \"hs_codes\": {\n \"export\": {},\n \"import\": {}\n },\n \"classification\": {\n \"source\": \"<string>\",\n \"reviewed\": true,\n \"reviewed_at\": 123\n },\n \"compliance\": {\n \"controlled\": true,\n \"eccn\": \"<string>\",\n \"license\": {\n \"number\": \"<string>\",\n \"expires_on\": \"2023-12-25\"\n },\n \"regulatory_agency\": \"<string>\",\n \"regulatory_program\": \"<string>\",\n \"regulatory_category_code\": \"<string>\",\n \"certification\": {\n \"type\": \"<string>\",\n \"reference\": \"<string>\"\n }\n },\n \"dangerous_goods\": {\n \"class\": \"<string>\",\n \"un_number\": \"<string>\",\n \"proper_shipping_name\": \"<string>\",\n \"packing_instruction\": \"<string>\",\n \"section\": \"<string>\",\n \"lithium\": {\n \"watt_hours\": 123,\n \"lithium_grams\": 123,\n \"cells\": 123\n },\n \"excepted_quantity\": true,\n \"limited_quantity\": true,\n \"emergency_contact\": {\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"declaration_document\": \"<string>\"\n },\n \"barcodes\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"product_url\": \"<string>\",\n \"image_url\": \"<string>\",\n \"external_ids\": [\n {\n \"source\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "prod_1Q2w3E4r",
"object": "product",
"livemode": true,
"created": 123,
"status": "active",
"sku": "<string>",
"updated": 123,
"title": "<string>",
"description": "<string>",
"variant_of": "<string>",
"options": {},
"category": "<string>",
"brand": "<string>",
"material": "<string>",
"origin_country": "<string>",
"manufacturer": {
"name": "<string>",
"country": "<string>",
"mid": "<string>"
},
"unit_value": {
"amount": 123,
"currency": "usd"
},
"unit_net_weight": {
"value": 123,
"unit": "g"
},
"unit_gross_weight": {
"value": 123,
"unit": "g"
},
"unit_dimensions": {
"length": 123,
"width": 123,
"height": 123,
"unit": "mm"
},
"hs_codes": {
"export": {},
"import": {}
},
"classification": {
"source": "<string>",
"reviewed": true,
"reviewed_at": 123
},
"compliance": {
"controlled": true,
"control_type": "dual_use",
"eccn": "<string>",
"license": {
"type": "export",
"number": "<string>",
"expires_on": "2023-12-25"
},
"regulatory_agency": "<string>",
"regulatory_program": "<string>",
"regulatory_category_code": "<string>",
"certification": {
"type": "<string>",
"reference": "<string>"
}
},
"dangerous_goods": {
"class": "<string>",
"un_number": "<string>",
"proper_shipping_name": "<string>",
"packing_group": "I",
"packing_instruction": "<string>",
"section": "<string>",
"quantity": {
"value": 123,
"unit": "g"
},
"lithium": {
"type": "ion",
"configuration": "alone",
"watt_hours": 123,
"lithium_grams": 123,
"cells": 123
},
"accessibility": "accessible",
"transport_mode": "air",
"excepted_quantity": true,
"limited_quantity": true,
"emergency_contact": {
"name": "<string>",
"phone": "<string>"
},
"declaration_document": "<string>"
},
"barcodes": [
{
"type": "<string>",
"value": "<string>"
}
],
"product_url": "<string>",
"image_url": "<string>",
"external_ids": [
{
"source": "<string>",
"id": "<string>"
}
],
"restrictions": [
{
"country": "<string>",
"level": "prohibited",
"agency": "<string>",
"code": "<string>",
"message": "<string>",
"license_types": [
"<string>"
],
"documents_required": [
"<string>"
]
}
],
"version": 123,
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}Authorizations
sk_test_ / sk_live_ / rk_test_ / rk_live_ keys
Headers
Act on behalf of a connected account (acct_...)
Product version for optimistic concurrency
Path Parameters
Body
active, archived, draft Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Client-writable. Up to 50 string key/value pairs. Never sent to carriers.
Show child attributes
Show child attributes
Response
OK
Prefixed prod_
"prod_1Q2w3E4r"
product Unix timestamp (seconds)
active, archived, draft Unix timestamp (seconds)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Client-writable. Up to 50 string key/value pairs. Never sent to carriers.
Show child attributes
Show child attributes
Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.
Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.
Show child attributes
Show child attributes