cURL
curl --request POST \
--url https://take.app/api/v2/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"price": 1,
"description": "<string>",
"sku": "<string>",
"reference_id": "<string>",
"original_price": 1,
"cost_enabled": true,
"cost": 1,
"unit_enabled": true,
"unit_value": 123,
"weight": 123,
"tax_override": true,
"tax_rate": 123,
"tags": [
"<string>"
],
"links": [
"<string>"
],
"category_ids": [
"<string>"
],
"daily_limit": 123,
"cart_limit": 123,
"cart_minimum": 123,
"inventory_enabled": true,
"inventory_quantity": 1,
"variants": [
{
"name": "<string>",
"price": 1,
"sku": "<string>",
"description": "<string>",
"original_price": 1,
"cost": 1,
"weight": 123,
"inventory_quantity": 1
}
],
"options": [
{
"text": "<string>",
"required": true,
"settings": {
"options": [
{
"text": "<string>",
"id": "<string>",
"price": 123,
"quantity": 1
}
],
"min": 1,
"max": 1,
"enableQuantity": true
}
}
],
"images": [
"<string>"
]
}
'import requests
url = "https://take.app/api/v2/products"
payload = {
"name": "<string>",
"price": 1,
"description": "<string>",
"sku": "<string>",
"reference_id": "<string>",
"original_price": 1,
"cost_enabled": True,
"cost": 1,
"unit_enabled": True,
"unit_value": 123,
"weight": 123,
"tax_override": True,
"tax_rate": 123,
"tags": ["<string>"],
"links": ["<string>"],
"category_ids": ["<string>"],
"daily_limit": 123,
"cart_limit": 123,
"cart_minimum": 123,
"inventory_enabled": True,
"inventory_quantity": 1,
"variants": [
{
"name": "<string>",
"price": 1,
"sku": "<string>",
"description": "<string>",
"original_price": 1,
"cost": 1,
"weight": 123,
"inventory_quantity": 1
}
],
"options": [
{
"text": "<string>",
"required": True,
"settings": {
"options": [
{
"text": "<string>",
"id": "<string>",
"price": 123,
"quantity": 1
}
],
"min": 1,
"max": 1,
"enableQuantity": True
}
}
],
"images": ["<string>"]
}
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({
name: '<string>',
price: 1,
description: '<string>',
sku: '<string>',
reference_id: '<string>',
original_price: 1,
cost_enabled: true,
cost: 1,
unit_enabled: true,
unit_value: 123,
weight: 123,
tax_override: true,
tax_rate: 123,
tags: ['<string>'],
links: ['<string>'],
category_ids: ['<string>'],
daily_limit: 123,
cart_limit: 123,
cart_minimum: 123,
inventory_enabled: true,
inventory_quantity: 1,
variants: [
{
name: '<string>',
price: 1,
sku: '<string>',
description: '<string>',
original_price: 1,
cost: 1,
weight: 123,
inventory_quantity: 1
}
],
options: [
{
text: '<string>',
required: true,
settings: {
options: [{text: '<string>', id: '<string>', price: 123, quantity: 1}],
min: 1,
max: 1,
enableQuantity: true
}
}
],
images: ['<string>']
})
};
fetch('https://take.app/api/v2/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://take.app/api/v2/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>',
'price' => 1,
'description' => '<string>',
'sku' => '<string>',
'reference_id' => '<string>',
'original_price' => 1,
'cost_enabled' => true,
'cost' => 1,
'unit_enabled' => true,
'unit_value' => 123,
'weight' => 123,
'tax_override' => true,
'tax_rate' => 123,
'tags' => [
'<string>'
],
'links' => [
'<string>'
],
'category_ids' => [
'<string>'
],
'daily_limit' => 123,
'cart_limit' => 123,
'cart_minimum' => 123,
'inventory_enabled' => true,
'inventory_quantity' => 1,
'variants' => [
[
'name' => '<string>',
'price' => 1,
'sku' => '<string>',
'description' => '<string>',
'original_price' => 1,
'cost' => 1,
'weight' => 123,
'inventory_quantity' => 1
]
],
'options' => [
[
'text' => '<string>',
'required' => true,
'settings' => [
'options' => [
[
'text' => '<string>',
'id' => '<string>',
'price' => 123,
'quantity' => 1
]
],
'min' => 1,
'max' => 1,
'enableQuantity' => true
]
]
],
'images' => [
'<string>'
]
]),
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://take.app/api/v2/products"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"price\": 1,\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"reference_id\": \"<string>\",\n \"original_price\": 1,\n \"cost_enabled\": true,\n \"cost\": 1,\n \"unit_enabled\": true,\n \"unit_value\": 123,\n \"weight\": 123,\n \"tax_override\": true,\n \"tax_rate\": 123,\n \"tags\": [\n \"<string>\"\n ],\n \"links\": [\n \"<string>\"\n ],\n \"category_ids\": [\n \"<string>\"\n ],\n \"daily_limit\": 123,\n \"cart_limit\": 123,\n \"cart_minimum\": 123,\n \"inventory_enabled\": true,\n \"inventory_quantity\": 1,\n \"variants\": [\n {\n \"name\": \"<string>\",\n \"price\": 1,\n \"sku\": \"<string>\",\n \"description\": \"<string>\",\n \"original_price\": 1,\n \"cost\": 1,\n \"weight\": 123,\n \"inventory_quantity\": 1\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"required\": true,\n \"settings\": {\n \"options\": [\n {\n \"text\": \"<string>\",\n \"id\": \"<string>\",\n \"price\": 123,\n \"quantity\": 1\n }\n ],\n \"min\": 1,\n \"max\": 1,\n \"enableQuantity\": true\n }\n }\n ],\n \"images\": [\n \"<string>\"\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://take.app/api/v2/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"price\": 1,\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"reference_id\": \"<string>\",\n \"original_price\": 1,\n \"cost_enabled\": true,\n \"cost\": 1,\n \"unit_enabled\": true,\n \"unit_value\": 123,\n \"weight\": 123,\n \"tax_override\": true,\n \"tax_rate\": 123,\n \"tags\": [\n \"<string>\"\n ],\n \"links\": [\n \"<string>\"\n ],\n \"category_ids\": [\n \"<string>\"\n ],\n \"daily_limit\": 123,\n \"cart_limit\": 123,\n \"cart_minimum\": 123,\n \"inventory_enabled\": true,\n \"inventory_quantity\": 1,\n \"variants\": [\n {\n \"name\": \"<string>\",\n \"price\": 1,\n \"sku\": \"<string>\",\n \"description\": \"<string>\",\n \"original_price\": 1,\n \"cost\": 1,\n \"weight\": 123,\n \"inventory_quantity\": 1\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"required\": true,\n \"settings\": {\n \"options\": [\n {\n \"text\": \"<string>\",\n \"id\": \"<string>\",\n \"price\": 123,\n \"quantity\": 1\n }\n ],\n \"min\": 1,\n \"max\": 1,\n \"enableQuantity\": true\n }\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://take.app/api/v2/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 \"name\": \"<string>\",\n \"price\": 1,\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"reference_id\": \"<string>\",\n \"original_price\": 1,\n \"cost_enabled\": true,\n \"cost\": 1,\n \"unit_enabled\": true,\n \"unit_value\": 123,\n \"weight\": 123,\n \"tax_override\": true,\n \"tax_rate\": 123,\n \"tags\": [\n \"<string>\"\n ],\n \"links\": [\n \"<string>\"\n ],\n \"category_ids\": [\n \"<string>\"\n ],\n \"daily_limit\": 123,\n \"cart_limit\": 123,\n \"cart_minimum\": 123,\n \"inventory_enabled\": true,\n \"inventory_quantity\": 1,\n \"variants\": [\n {\n \"name\": \"<string>\",\n \"price\": 1,\n \"sku\": \"<string>\",\n \"description\": \"<string>\",\n \"original_price\": 1,\n \"cost\": 1,\n \"weight\": 123,\n \"inventory_quantity\": 1\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"required\": true,\n \"settings\": {\n \"options\": [\n {\n \"text\": \"<string>\",\n \"id\": \"<string>\",\n \"price\": 123,\n \"quantity\": 1\n }\n ],\n \"min\": 1,\n \"max\": 1,\n \"enableQuantity\": true\n }\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "product",
"reference_id": "<string>",
"name": "<string>",
"description": "<string>",
"sku": "<string>",
"status": "VISIBLE",
"type": "PHYSICAL",
"price": 123,
"original_price": 123,
"cost_enabled": true,
"cost": 123,
"unit_enabled": true,
"unit": "QTY",
"unit_value": 123,
"weight": 123,
"tax_override": true,
"tax_rate": 123,
"tags": [
"<string>"
],
"links": [
"<string>"
],
"category_ids": [
"<string>"
],
"daily_limit": 123,
"cart_limit": 123,
"cart_minimum": 123,
"inventory_enabled": true,
"soldout": true,
"inventory": {
"item_id": "<string>",
"object": "inventory_item",
"item_type": "product",
"item_name": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"sku": "<string>",
"quantity": 123,
"price": 123,
"original_price": 123,
"cost": 123,
"cost_enabled": true,
"updated_at": "2023-11-07T05:31:56Z"
},
"variants": [
{
"id": "<string>",
"object": "variant",
"product_id": "<string>",
"name": "<string>",
"sku": "<string>",
"description": "<string>",
"price": 123,
"original_price": 123,
"cost": 123,
"weight": 123,
"inventory": {
"item_id": "<string>",
"object": "inventory_item",
"item_type": "product",
"item_name": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"sku": "<string>",
"quantity": 123,
"price": 123,
"original_price": 123,
"cost": 123,
"cost_enabled": true,
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"options": [
{
"id": "<string>",
"object": "product_option",
"type": "OPTION_TEXT",
"text": "<string>",
"required": true,
"settings": "<unknown>"
}
],
"images": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}Products
Create product
POST
/
api
/
v2
/
products
cURL
curl --request POST \
--url https://take.app/api/v2/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"price": 1,
"description": "<string>",
"sku": "<string>",
"reference_id": "<string>",
"original_price": 1,
"cost_enabled": true,
"cost": 1,
"unit_enabled": true,
"unit_value": 123,
"weight": 123,
"tax_override": true,
"tax_rate": 123,
"tags": [
"<string>"
],
"links": [
"<string>"
],
"category_ids": [
"<string>"
],
"daily_limit": 123,
"cart_limit": 123,
"cart_minimum": 123,
"inventory_enabled": true,
"inventory_quantity": 1,
"variants": [
{
"name": "<string>",
"price": 1,
"sku": "<string>",
"description": "<string>",
"original_price": 1,
"cost": 1,
"weight": 123,
"inventory_quantity": 1
}
],
"options": [
{
"text": "<string>",
"required": true,
"settings": {
"options": [
{
"text": "<string>",
"id": "<string>",
"price": 123,
"quantity": 1
}
],
"min": 1,
"max": 1,
"enableQuantity": true
}
}
],
"images": [
"<string>"
]
}
'import requests
url = "https://take.app/api/v2/products"
payload = {
"name": "<string>",
"price": 1,
"description": "<string>",
"sku": "<string>",
"reference_id": "<string>",
"original_price": 1,
"cost_enabled": True,
"cost": 1,
"unit_enabled": True,
"unit_value": 123,
"weight": 123,
"tax_override": True,
"tax_rate": 123,
"tags": ["<string>"],
"links": ["<string>"],
"category_ids": ["<string>"],
"daily_limit": 123,
"cart_limit": 123,
"cart_minimum": 123,
"inventory_enabled": True,
"inventory_quantity": 1,
"variants": [
{
"name": "<string>",
"price": 1,
"sku": "<string>",
"description": "<string>",
"original_price": 1,
"cost": 1,
"weight": 123,
"inventory_quantity": 1
}
],
"options": [
{
"text": "<string>",
"required": True,
"settings": {
"options": [
{
"text": "<string>",
"id": "<string>",
"price": 123,
"quantity": 1
}
],
"min": 1,
"max": 1,
"enableQuantity": True
}
}
],
"images": ["<string>"]
}
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({
name: '<string>',
price: 1,
description: '<string>',
sku: '<string>',
reference_id: '<string>',
original_price: 1,
cost_enabled: true,
cost: 1,
unit_enabled: true,
unit_value: 123,
weight: 123,
tax_override: true,
tax_rate: 123,
tags: ['<string>'],
links: ['<string>'],
category_ids: ['<string>'],
daily_limit: 123,
cart_limit: 123,
cart_minimum: 123,
inventory_enabled: true,
inventory_quantity: 1,
variants: [
{
name: '<string>',
price: 1,
sku: '<string>',
description: '<string>',
original_price: 1,
cost: 1,
weight: 123,
inventory_quantity: 1
}
],
options: [
{
text: '<string>',
required: true,
settings: {
options: [{text: '<string>', id: '<string>', price: 123, quantity: 1}],
min: 1,
max: 1,
enableQuantity: true
}
}
],
images: ['<string>']
})
};
fetch('https://take.app/api/v2/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://take.app/api/v2/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>',
'price' => 1,
'description' => '<string>',
'sku' => '<string>',
'reference_id' => '<string>',
'original_price' => 1,
'cost_enabled' => true,
'cost' => 1,
'unit_enabled' => true,
'unit_value' => 123,
'weight' => 123,
'tax_override' => true,
'tax_rate' => 123,
'tags' => [
'<string>'
],
'links' => [
'<string>'
],
'category_ids' => [
'<string>'
],
'daily_limit' => 123,
'cart_limit' => 123,
'cart_minimum' => 123,
'inventory_enabled' => true,
'inventory_quantity' => 1,
'variants' => [
[
'name' => '<string>',
'price' => 1,
'sku' => '<string>',
'description' => '<string>',
'original_price' => 1,
'cost' => 1,
'weight' => 123,
'inventory_quantity' => 1
]
],
'options' => [
[
'text' => '<string>',
'required' => true,
'settings' => [
'options' => [
[
'text' => '<string>',
'id' => '<string>',
'price' => 123,
'quantity' => 1
]
],
'min' => 1,
'max' => 1,
'enableQuantity' => true
]
]
],
'images' => [
'<string>'
]
]),
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://take.app/api/v2/products"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"price\": 1,\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"reference_id\": \"<string>\",\n \"original_price\": 1,\n \"cost_enabled\": true,\n \"cost\": 1,\n \"unit_enabled\": true,\n \"unit_value\": 123,\n \"weight\": 123,\n \"tax_override\": true,\n \"tax_rate\": 123,\n \"tags\": [\n \"<string>\"\n ],\n \"links\": [\n \"<string>\"\n ],\n \"category_ids\": [\n \"<string>\"\n ],\n \"daily_limit\": 123,\n \"cart_limit\": 123,\n \"cart_minimum\": 123,\n \"inventory_enabled\": true,\n \"inventory_quantity\": 1,\n \"variants\": [\n {\n \"name\": \"<string>\",\n \"price\": 1,\n \"sku\": \"<string>\",\n \"description\": \"<string>\",\n \"original_price\": 1,\n \"cost\": 1,\n \"weight\": 123,\n \"inventory_quantity\": 1\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"required\": true,\n \"settings\": {\n \"options\": [\n {\n \"text\": \"<string>\",\n \"id\": \"<string>\",\n \"price\": 123,\n \"quantity\": 1\n }\n ],\n \"min\": 1,\n \"max\": 1,\n \"enableQuantity\": true\n }\n }\n ],\n \"images\": [\n \"<string>\"\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://take.app/api/v2/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"price\": 1,\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"reference_id\": \"<string>\",\n \"original_price\": 1,\n \"cost_enabled\": true,\n \"cost\": 1,\n \"unit_enabled\": true,\n \"unit_value\": 123,\n \"weight\": 123,\n \"tax_override\": true,\n \"tax_rate\": 123,\n \"tags\": [\n \"<string>\"\n ],\n \"links\": [\n \"<string>\"\n ],\n \"category_ids\": [\n \"<string>\"\n ],\n \"daily_limit\": 123,\n \"cart_limit\": 123,\n \"cart_minimum\": 123,\n \"inventory_enabled\": true,\n \"inventory_quantity\": 1,\n \"variants\": [\n {\n \"name\": \"<string>\",\n \"price\": 1,\n \"sku\": \"<string>\",\n \"description\": \"<string>\",\n \"original_price\": 1,\n \"cost\": 1,\n \"weight\": 123,\n \"inventory_quantity\": 1\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"required\": true,\n \"settings\": {\n \"options\": [\n {\n \"text\": \"<string>\",\n \"id\": \"<string>\",\n \"price\": 123,\n \"quantity\": 1\n }\n ],\n \"min\": 1,\n \"max\": 1,\n \"enableQuantity\": true\n }\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://take.app/api/v2/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 \"name\": \"<string>\",\n \"price\": 1,\n \"description\": \"<string>\",\n \"sku\": \"<string>\",\n \"reference_id\": \"<string>\",\n \"original_price\": 1,\n \"cost_enabled\": true,\n \"cost\": 1,\n \"unit_enabled\": true,\n \"unit_value\": 123,\n \"weight\": 123,\n \"tax_override\": true,\n \"tax_rate\": 123,\n \"tags\": [\n \"<string>\"\n ],\n \"links\": [\n \"<string>\"\n ],\n \"category_ids\": [\n \"<string>\"\n ],\n \"daily_limit\": 123,\n \"cart_limit\": 123,\n \"cart_minimum\": 123,\n \"inventory_enabled\": true,\n \"inventory_quantity\": 1,\n \"variants\": [\n {\n \"name\": \"<string>\",\n \"price\": 1,\n \"sku\": \"<string>\",\n \"description\": \"<string>\",\n \"original_price\": 1,\n \"cost\": 1,\n \"weight\": 123,\n \"inventory_quantity\": 1\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"required\": true,\n \"settings\": {\n \"options\": [\n {\n \"text\": \"<string>\",\n \"id\": \"<string>\",\n \"price\": 123,\n \"quantity\": 1\n }\n ],\n \"min\": 1,\n \"max\": 1,\n \"enableQuantity\": true\n }\n }\n ],\n \"images\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "product",
"reference_id": "<string>",
"name": "<string>",
"description": "<string>",
"sku": "<string>",
"status": "VISIBLE",
"type": "PHYSICAL",
"price": 123,
"original_price": 123,
"cost_enabled": true,
"cost": 123,
"unit_enabled": true,
"unit": "QTY",
"unit_value": 123,
"weight": 123,
"tax_override": true,
"tax_rate": 123,
"tags": [
"<string>"
],
"links": [
"<string>"
],
"category_ids": [
"<string>"
],
"daily_limit": 123,
"cart_limit": 123,
"cart_minimum": 123,
"inventory_enabled": true,
"soldout": true,
"inventory": {
"item_id": "<string>",
"object": "inventory_item",
"item_type": "product",
"item_name": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"sku": "<string>",
"quantity": 123,
"price": 123,
"original_price": 123,
"cost": 123,
"cost_enabled": true,
"updated_at": "2023-11-07T05:31:56Z"
},
"variants": [
{
"id": "<string>",
"object": "variant",
"product_id": "<string>",
"name": "<string>",
"sku": "<string>",
"description": "<string>",
"price": 123,
"original_price": 123,
"cost": 123,
"weight": 123,
"inventory": {
"item_id": "<string>",
"object": "inventory_item",
"item_type": "product",
"item_name": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"sku": "<string>",
"quantity": 123,
"price": 123,
"original_price": 123,
"cost": 123,
"cost_enabled": true,
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"options": [
{
"id": "<string>",
"object": "product_option",
"type": "OPTION_TEXT",
"text": "<string>",
"required": true,
"settings": "<unknown>"
}
],
"images": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}Authorizations
Merchant API V2 token. Pass as Authorization: Bearer <token>.
Body
application/json
Minimum string length:
1Required range:
x >= 0Supports a small Markdown subset: **bold**, _italic_, ~strike~, [text](url), , and bare http(s) URLs, which become links. Line breaks are kept. Headings, lists, tables and HTML are not parsed and render as literal text.
Available options:
VISIBLE, HIDDEN Available options:
PHYSICAL, DIGITAL, SUBSCRIPTION, BOOKING, OTHERS Compare-at price, struck through next to the price to show a markdown. Defaults to 0, which shows no strike-through. Set it above price to advertise a discount — the storefront does not check that it is higher, so a value at or below price reads as a mistake to shoppers.
Required range:
x >= 0Required range:
x >= 0Available options:
QTY, KG, G, ML, L, PCS, PAX, PACK, PERSON, ROOM, LBS, HOUR, BOX Pattern:
^https?:\/\//iCategories the product belongs to. A product with no category is not listed on the storefront.
Required range:
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Product images, in display order. Every image is copied onto Take App storage, so send a source URL once and use the URLs returned here from then on — a URL that is already ours is kept as-is, any other URL is fetched and stored again. Omitting the field leaves the images alone; sending an empty array removes them all.
Maximum array length:
10Pattern:
^https?:\/\//iResponse
Product
Available options:
product Supports a small Markdown subset: **bold**, _italic_, ~strike~, [text](url), , and bare http(s) URLs, which become links. Line breaks are kept. Headings, lists, tables and HTML are not parsed and render as literal text.
Available options:
VISIBLE, HIDDEN Available options:
PHYSICAL, DIGITAL, SUBSCRIPTION, BOOKING, OTHERS Integer amount in the smallest unit of the store currency (e.g. cents).
Compare-at price, struck through next to the price to show a markdown. Defaults to 0, which shows no strike-through. Set it above price to advertise a discount — the storefront does not check that it is higher, so a value at or below price reads as a mistake to shoppers.
Integer amount in the smallest unit of the store currency (e.g. cents).
Available options:
QTY, KG, G, ML, L, PCS, PAX, PACK, PERSON, ROOM, LBS, HOUR, BOX Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Product images, in display order. Every image is copied onto Take App storage, so send a source URL once and use the URLs returned here from then on — a URL that is already ours is kept as-is, any other URL is fetched and stored again. Omitting the field leaves the images alone; sending an empty array removes them all.