curl --request PATCH \
--url https://api.1club.ai/v1/platform/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"price": 1,
"costPrice": 1,
"clubId": 123,
"categoryId": 123,
"brandId": 123,
"sku": "<string>",
"barcode": "<string>",
"isActive": true,
"taxRateId": 123,
"revenueAccountId": 123,
"images": [
"<string>"
],
"features": [
"<string>"
]
}
'import requests
url = "https://api.1club.ai/v1/platform/products/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"price": 1,
"costPrice": 1,
"clubId": 123,
"categoryId": 123,
"brandId": 123,
"sku": "<string>",
"barcode": "<string>",
"isActive": True,
"taxRateId": 123,
"revenueAccountId": 123,
"images": ["<string>"],
"features": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
price: 1,
costPrice: 1,
clubId: 123,
categoryId: 123,
brandId: 123,
sku: '<string>',
barcode: '<string>',
isActive: true,
taxRateId: 123,
revenueAccountId: 123,
images: ['<string>'],
features: ['<string>']
})
};
fetch('https://api.1club.ai/v1/platform/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.1club.ai/v1/platform/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'price' => 1,
'costPrice' => 1,
'clubId' => 123,
'categoryId' => 123,
'brandId' => 123,
'sku' => '<string>',
'barcode' => '<string>',
'isActive' => true,
'taxRateId' => 123,
'revenueAccountId' => 123,
'images' => [
'<string>'
],
'features' => [
'<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://api.1club.ai/v1/platform/products/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price\": 1,\n \"costPrice\": 1,\n \"clubId\": 123,\n \"categoryId\": 123,\n \"brandId\": 123,\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"isActive\": true,\n \"taxRateId\": 123,\n \"revenueAccountId\": 123,\n \"images\": [\n \"<string>\"\n ],\n \"features\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.1club.ai/v1/platform/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price\": 1,\n \"costPrice\": 1,\n \"clubId\": 123,\n \"categoryId\": 123,\n \"brandId\": 123,\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"isActive\": true,\n \"taxRateId\": 123,\n \"revenueAccountId\": 123,\n \"images\": [\n \"<string>\"\n ],\n \"features\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price\": 1,\n \"costPrice\": 1,\n \"clubId\": 123,\n \"categoryId\": 123,\n \"brandId\": 123,\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"isActive\": true,\n \"taxRateId\": 123,\n \"revenueAccountId\": 123,\n \"images\": [\n \"<string>\"\n ],\n \"features\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"productId": 123,
"name": "<string>",
"description": "<string>",
"clubId": 123,
"categoryId": 123,
"brandId": 123,
"sku": "<string>",
"barcode": "<string>",
"price": 123,
"costPrice": 123,
"isActive": true,
"visibility": "Public",
"images": [
"<string>"
],
"features": [
"<string>"
],
"taxRateId": 123,
"revenueAccountId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Update a product
Changes the fields you send and leaves the rest alone - nothing is required. Send null to clear a nullable field (categoryId, barcode, costPrice, …); omit it to keep what is there. images and features are arrays and replace wholesale, so read the product first if you are adding to one.
A barcode or sku is only checked for collisions when you actually send it, so re-saving a product without touching its codes never conflicts with itself.
Set isActive: false to retire a product rather than deleting it - that keeps its sales history intact and takes it off the till.
curl --request PATCH \
--url https://api.1club.ai/v1/platform/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"price": 1,
"costPrice": 1,
"clubId": 123,
"categoryId": 123,
"brandId": 123,
"sku": "<string>",
"barcode": "<string>",
"isActive": true,
"taxRateId": 123,
"revenueAccountId": 123,
"images": [
"<string>"
],
"features": [
"<string>"
]
}
'import requests
url = "https://api.1club.ai/v1/platform/products/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"price": 1,
"costPrice": 1,
"clubId": 123,
"categoryId": 123,
"brandId": 123,
"sku": "<string>",
"barcode": "<string>",
"isActive": True,
"taxRateId": 123,
"revenueAccountId": 123,
"images": ["<string>"],
"features": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
price: 1,
costPrice: 1,
clubId: 123,
categoryId: 123,
brandId: 123,
sku: '<string>',
barcode: '<string>',
isActive: true,
taxRateId: 123,
revenueAccountId: 123,
images: ['<string>'],
features: ['<string>']
})
};
fetch('https://api.1club.ai/v1/platform/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.1club.ai/v1/platform/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'price' => 1,
'costPrice' => 1,
'clubId' => 123,
'categoryId' => 123,
'brandId' => 123,
'sku' => '<string>',
'barcode' => '<string>',
'isActive' => true,
'taxRateId' => 123,
'revenueAccountId' => 123,
'images' => [
'<string>'
],
'features' => [
'<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://api.1club.ai/v1/platform/products/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price\": 1,\n \"costPrice\": 1,\n \"clubId\": 123,\n \"categoryId\": 123,\n \"brandId\": 123,\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"isActive\": true,\n \"taxRateId\": 123,\n \"revenueAccountId\": 123,\n \"images\": [\n \"<string>\"\n ],\n \"features\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.1club.ai/v1/platform/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price\": 1,\n \"costPrice\": 1,\n \"clubId\": 123,\n \"categoryId\": 123,\n \"brandId\": 123,\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"isActive\": true,\n \"taxRateId\": 123,\n \"revenueAccountId\": 123,\n \"images\": [\n \"<string>\"\n ],\n \"features\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.1club.ai/v1/platform/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price\": 1,\n \"costPrice\": 1,\n \"clubId\": 123,\n \"categoryId\": 123,\n \"brandId\": 123,\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"isActive\": true,\n \"taxRateId\": 123,\n \"revenueAccountId\": 123,\n \"images\": [\n \"<string>\"\n ],\n \"features\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"productId": 123,
"name": "<string>",
"description": "<string>",
"clubId": 123,
"categoryId": 123,
"brandId": 123,
"sku": "<string>",
"barcode": "<string>",
"price": 123,
"costPrice": 123,
"isActive": true,
"visibility": "Public",
"images": [
"<string>"
],
"features": [
"<string>"
],
"taxRateId": 123,
"revenueAccountId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"details": {}
}Authorizations
Body
Fields accepted when updating a product. Send only what changes; null clears a nullable field, and an omitted field is left alone. At least one field is required.
Response
The updated product
A product the organization sells over the counter.
Was this page helpful?