Update a product
curl --request PUT \
--url https://api.sentralbee.app/v1/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"categories": [
"men",
"kaftan"
],
"tags": [
"<string>"
],
"description": "<string>",
"requires_shipping": true,
"can_preorder": true,
"preorder_stops_at": "2023-11-07T05:31:56Z",
"max_cart_quantity": 123,
"low_stock_threshold": 123,
"tax_class": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purchase_note": "<string>",
"sku": "<string>",
"price": {
"NGN": 450000,
"USD": 2900
},
"cost": {
"NGN": 450000,
"USD": 2900
},
"stock": 123,
"medias": [
{
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123
}
],
"remove_medias": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.sentralbee.app/v1/products/{id}"
payload = {
"name": "<string>",
"slug": "<string>",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"categories": ["men", "kaftan"],
"tags": ["<string>"],
"description": "<string>",
"requires_shipping": True,
"can_preorder": True,
"preorder_stops_at": "2023-11-07T05:31:56Z",
"max_cart_quantity": 123,
"low_stock_threshold": 123,
"tax_class": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purchase_note": "<string>",
"sku": "<string>",
"price": {
"NGN": 450000,
"USD": 2900
},
"cost": {
"NGN": 450000,
"USD": 2900
},
"stock": 123,
"medias": [
{
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123
}
],
"remove_medias": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
category: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', name: '<string>'},
categories: ['men', 'kaftan'],
tags: ['<string>'],
description: '<string>',
requires_shipping: true,
can_preorder: true,
preorder_stops_at: '2023-11-07T05:31:56Z',
max_cart_quantity: 123,
low_stock_threshold: 123,
tax_class: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
purchase_note: '<string>',
sku: '<string>',
price: {NGN: 450000, USD: 2900},
cost: {NGN: 450000, USD: 2900},
stock: 123,
medias: [
{
asset: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
position: 123
}
],
remove_medias: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.sentralbee.app/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.sentralbee.app/v1/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'category' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>'
],
'categories' => [
'men',
'kaftan'
],
'tags' => [
'<string>'
],
'description' => '<string>',
'requires_shipping' => true,
'can_preorder' => true,
'preorder_stops_at' => '2023-11-07T05:31:56Z',
'max_cart_quantity' => 123,
'low_stock_threshold' => 123,
'tax_class' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'purchase_note' => '<string>',
'sku' => '<string>',
'price' => [
'NGN' => 450000,
'USD' => 2900
],
'cost' => [
'NGN' => 450000,
'USD' => 2900
],
'stock' => 123,
'medias' => [
[
'asset' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'position' => 123
]
],
'remove_medias' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
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.sentralbee.app/v1/products/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"category\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n },\n \"categories\": [\n \"men\",\n \"kaftan\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"requires_shipping\": true,\n \"can_preorder\": true,\n \"preorder_stops_at\": \"2023-11-07T05:31:56Z\",\n \"max_cart_quantity\": 123,\n \"low_stock_threshold\": 123,\n \"tax_class\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purchase_note\": \"<string>\",\n \"sku\": \"<string>\",\n \"price\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"cost\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"stock\": 123,\n \"medias\": [\n {\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 123\n }\n ],\n \"remove_medias\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sentralbee.app/v1/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"category\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n },\n \"categories\": [\n \"men\",\n \"kaftan\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"requires_shipping\": true,\n \"can_preorder\": true,\n \"preorder_stops_at\": \"2023-11-07T05:31:56Z\",\n \"max_cart_quantity\": 123,\n \"low_stock_threshold\": 123,\n \"tax_class\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purchase_note\": \"<string>\",\n \"sku\": \"<string>\",\n \"price\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"cost\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"stock\": 123,\n \"medias\": [\n {\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 123\n }\n ],\n \"remove_medias\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sentralbee.app/v1/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"category\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n },\n \"categories\": [\n \"men\",\n \"kaftan\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"requires_shipping\": true,\n \"can_preorder\": true,\n \"preorder_stops_at\": \"2023-11-07T05:31:56Z\",\n \"max_cart_quantity\": 123,\n \"low_stock_threshold\": 123,\n \"tax_class\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purchase_note\": \"<string>\",\n \"sku\": \"<string>\",\n \"price\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"cost\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"stock\": 123,\n \"medias\": [\n {\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 123\n }\n ],\n \"remove_medias\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"type": "<string>",
"description": "<string>",
"category": "<string>",
"categories": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Kaftan",
"slug": "kaftan",
"parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_slug": "men"
}
],
"requires_shipping": true,
"can_preorder": true,
"total_stock": 123,
"price_range": {},
"options": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Color",
"values": [
"Red",
"Blue"
]
}
],
"media": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"thumbnail": "<string>",
"type": "<string>",
"position": 123
}
],
"variants": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"stock": 123,
"price": {},
"attributes": {}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}Products
Update a product
Updates a product’s fields, media, tags, slug, and — for a
non-variable product — its single default variant (price/cost/stock/sku). A
type switch between simple and variable is honored (the default variant is
created or removed accordingly). Variable-product variants are managed through
the variant endpoints, not here.
PUT
/
products
/
{id}
Update a product
curl --request PUT \
--url https://api.sentralbee.app/v1/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"categories": [
"men",
"kaftan"
],
"tags": [
"<string>"
],
"description": "<string>",
"requires_shipping": true,
"can_preorder": true,
"preorder_stops_at": "2023-11-07T05:31:56Z",
"max_cart_quantity": 123,
"low_stock_threshold": 123,
"tax_class": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purchase_note": "<string>",
"sku": "<string>",
"price": {
"NGN": 450000,
"USD": 2900
},
"cost": {
"NGN": 450000,
"USD": 2900
},
"stock": 123,
"medias": [
{
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123
}
],
"remove_medias": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.sentralbee.app/v1/products/{id}"
payload = {
"name": "<string>",
"slug": "<string>",
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"categories": ["men", "kaftan"],
"tags": ["<string>"],
"description": "<string>",
"requires_shipping": True,
"can_preorder": True,
"preorder_stops_at": "2023-11-07T05:31:56Z",
"max_cart_quantity": 123,
"low_stock_threshold": 123,
"tax_class": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purchase_note": "<string>",
"sku": "<string>",
"price": {
"NGN": 450000,
"USD": 2900
},
"cost": {
"NGN": 450000,
"USD": 2900
},
"stock": 123,
"medias": [
{
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123
}
],
"remove_medias": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
category: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', name: '<string>'},
categories: ['men', 'kaftan'],
tags: ['<string>'],
description: '<string>',
requires_shipping: true,
can_preorder: true,
preorder_stops_at: '2023-11-07T05:31:56Z',
max_cart_quantity: 123,
low_stock_threshold: 123,
tax_class: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
purchase_note: '<string>',
sku: '<string>',
price: {NGN: 450000, USD: 2900},
cost: {NGN: 450000, USD: 2900},
stock: 123,
medias: [
{
asset: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
position: 123
}
],
remove_medias: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.sentralbee.app/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.sentralbee.app/v1/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'category' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>'
],
'categories' => [
'men',
'kaftan'
],
'tags' => [
'<string>'
],
'description' => '<string>',
'requires_shipping' => true,
'can_preorder' => true,
'preorder_stops_at' => '2023-11-07T05:31:56Z',
'max_cart_quantity' => 123,
'low_stock_threshold' => 123,
'tax_class' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'purchase_note' => '<string>',
'sku' => '<string>',
'price' => [
'NGN' => 450000,
'USD' => 2900
],
'cost' => [
'NGN' => 450000,
'USD' => 2900
],
'stock' => 123,
'medias' => [
[
'asset' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'position' => 123
]
],
'remove_medias' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
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.sentralbee.app/v1/products/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"category\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n },\n \"categories\": [\n \"men\",\n \"kaftan\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"requires_shipping\": true,\n \"can_preorder\": true,\n \"preorder_stops_at\": \"2023-11-07T05:31:56Z\",\n \"max_cart_quantity\": 123,\n \"low_stock_threshold\": 123,\n \"tax_class\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purchase_note\": \"<string>\",\n \"sku\": \"<string>\",\n \"price\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"cost\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"stock\": 123,\n \"medias\": [\n {\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 123\n }\n ],\n \"remove_medias\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sentralbee.app/v1/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"category\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n },\n \"categories\": [\n \"men\",\n \"kaftan\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"requires_shipping\": true,\n \"can_preorder\": true,\n \"preorder_stops_at\": \"2023-11-07T05:31:56Z\",\n \"max_cart_quantity\": 123,\n \"low_stock_threshold\": 123,\n \"tax_class\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purchase_note\": \"<string>\",\n \"sku\": \"<string>\",\n \"price\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"cost\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"stock\": 123,\n \"medias\": [\n {\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 123\n }\n ],\n \"remove_medias\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sentralbee.app/v1/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"category\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\"\n },\n \"categories\": [\n \"men\",\n \"kaftan\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"requires_shipping\": true,\n \"can_preorder\": true,\n \"preorder_stops_at\": \"2023-11-07T05:31:56Z\",\n \"max_cart_quantity\": 123,\n \"low_stock_threshold\": 123,\n \"tax_class\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purchase_note\": \"<string>\",\n \"sku\": \"<string>\",\n \"price\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"cost\": {\n \"NGN\": 450000,\n \"USD\": 2900\n },\n \"stock\": 123,\n \"medias\": [\n {\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position\": 123\n }\n ],\n \"remove_medias\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"type": "<string>",
"description": "<string>",
"category": "<string>",
"categories": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Kaftan",
"slug": "kaftan",
"parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_slug": "men"
}
],
"requires_shipping": true,
"can_preorder": true,
"total_stock": 123,
"price_range": {},
"options": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Color",
"values": [
"Red",
"Blue"
]
}
],
"media": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"thumbnail": "<string>",
"type": "<string>",
"position": 123
}
],
"variants": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"stock": 123,
"price": {},
"attributes": {}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"request_id": "<string>"
}
}Authorizations
Workspace API key. The workspace is derived from the key.
Path Parameters
Resource UUID.
Body
application/json
Full product update. For a non-variable product, price, cost and stock
set the single default variant. tags replaces the tag set (omit to leave
untouched, [] to clear). slug is only changed when supplied. medias
adds/repositions media; remove_medias detaches by id.
Available options:
SIMPLE_PRODUCT, VARIABLE_PRODUCT, VIRTUAL_PRODUCT Available options:
ACTIVE, HIDDEN, ARCHIVED Legacy single category — by id, or by name (created if missing). Prefer
categories; if both are sent, categories wins.
Show child attributes
Show child attributes
Ordered list of category ids or slugs (first = primary). Replaces the
category set; [] clears all memberships. Wins over category. An unknown
id/slug returns 422 unprocessable and nothing is applied.
Example:
["men", "kaftan"]
Currency code → amount in minor units (e.g. NGN 450000 = 4500.00).
Show child attributes
Show child attributes
Example:
{ "NGN": 450000, "USD": 2900 }
Currency code → amount in minor units (e.g. NGN 450000 = 4500.00).
Show child attributes
Show child attributes
Example:
{ "NGN": 450000, "USD": 2900 }
Show child attributes
Show child attributes
Response
The updated product
The primary category's name (the first of categories). Kept for
backwards compatibility — prefer categories.
The product's categories, ordered (first = primary). Each entry carries
its parent/parent_slug, so a headless storefront can build
/shop/{parent_slug}/{slug} links with no extra calls.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The product's resolved options. Each variant's attributes is keyed by
the option id here, so use this to map a variant back to option names/values.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Created variants. Each variant's attributes maps an option id (see
options) to the chosen value key.
Show child attributes
Show child attributes