Update inventory
curl --request PATCH \
--url https://shelfforce.ai/api/v1/inventory/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sku": "CC-330ML-CAN",
"brand": "Coca-Cola",
"name": "Coca-Cola Original 330ml Can",
"category": "Beverages",
"subcategory": "Carbonated Soft Drinks",
"sizeValue": 330,
"sizeUnit": "ml",
"expectedPrice": 1.49,
"currency": "USD",
"upc": "049000042566"
}
'import requests
url = "https://shelfforce.ai/api/v1/inventory/{id}"
payload = {
"sku": "CC-330ML-CAN",
"brand": "Coca-Cola",
"name": "Coca-Cola Original 330ml Can",
"category": "Beverages",
"subcategory": "Carbonated Soft Drinks",
"sizeValue": 330,
"sizeUnit": "ml",
"expectedPrice": 1.49,
"currency": "USD",
"upc": "049000042566"
}
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({
sku: 'CC-330ML-CAN',
brand: 'Coca-Cola',
name: 'Coca-Cola Original 330ml Can',
category: 'Beverages',
subcategory: 'Carbonated Soft Drinks',
sizeValue: 330,
sizeUnit: 'ml',
expectedPrice: 1.49,
currency: 'USD',
upc: '049000042566'
})
};
fetch('https://shelfforce.ai/api/v1/inventory/{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://shelfforce.ai/api/v1/inventory/{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([
'sku' => 'CC-330ML-CAN',
'brand' => 'Coca-Cola',
'name' => 'Coca-Cola Original 330ml Can',
'category' => 'Beverages',
'subcategory' => 'Carbonated Soft Drinks',
'sizeValue' => 330,
'sizeUnit' => 'ml',
'expectedPrice' => 1.49,
'currency' => 'USD',
'upc' => '049000042566'
]),
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://shelfforce.ai/api/v1/inventory/{id}"
payload := strings.NewReader("{\n \"sku\": \"CC-330ML-CAN\",\n \"brand\": \"Coca-Cola\",\n \"name\": \"Coca-Cola Original 330ml Can\",\n \"category\": \"Beverages\",\n \"subcategory\": \"Carbonated Soft Drinks\",\n \"sizeValue\": 330,\n \"sizeUnit\": \"ml\",\n \"expectedPrice\": 1.49,\n \"currency\": \"USD\",\n \"upc\": \"049000042566\"\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://shelfforce.ai/api/v1/inventory/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sku\": \"CC-330ML-CAN\",\n \"brand\": \"Coca-Cola\",\n \"name\": \"Coca-Cola Original 330ml Can\",\n \"category\": \"Beverages\",\n \"subcategory\": \"Carbonated Soft Drinks\",\n \"sizeValue\": 330,\n \"sizeUnit\": \"ml\",\n \"expectedPrice\": 1.49,\n \"currency\": \"USD\",\n \"upc\": \"049000042566\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://shelfforce.ai/api/v1/inventory/{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 \"sku\": \"CC-330ML-CAN\",\n \"brand\": \"Coca-Cola\",\n \"name\": \"Coca-Cola Original 330ml Can\",\n \"category\": \"Beverages\",\n \"subcategory\": \"Carbonated Soft Drinks\",\n \"sizeValue\": 330,\n \"sizeUnit\": \"ml\",\n \"expectedPrice\": 1.49,\n \"currency\": \"USD\",\n \"upc\": \"049000042566\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "inv_a1b2c3",
"updatedAt": "2026-02-23T11:00:00Z"
}
}{
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid or has been revoked."
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Analysis 'an_g7h8j9k0' not found."
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "The 'imageUrl' field must be a valid URL."
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred. Please try again or contact support with request ID."
}
}Update inventory
Updates one or more fields on an existing inventory item.
PATCH
/
api
/
v1
/
inventory
/
{id}
Update inventory
curl --request PATCH \
--url https://shelfforce.ai/api/v1/inventory/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sku": "CC-330ML-CAN",
"brand": "Coca-Cola",
"name": "Coca-Cola Original 330ml Can",
"category": "Beverages",
"subcategory": "Carbonated Soft Drinks",
"sizeValue": 330,
"sizeUnit": "ml",
"expectedPrice": 1.49,
"currency": "USD",
"upc": "049000042566"
}
'import requests
url = "https://shelfforce.ai/api/v1/inventory/{id}"
payload = {
"sku": "CC-330ML-CAN",
"brand": "Coca-Cola",
"name": "Coca-Cola Original 330ml Can",
"category": "Beverages",
"subcategory": "Carbonated Soft Drinks",
"sizeValue": 330,
"sizeUnit": "ml",
"expectedPrice": 1.49,
"currency": "USD",
"upc": "049000042566"
}
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({
sku: 'CC-330ML-CAN',
brand: 'Coca-Cola',
name: 'Coca-Cola Original 330ml Can',
category: 'Beverages',
subcategory: 'Carbonated Soft Drinks',
sizeValue: 330,
sizeUnit: 'ml',
expectedPrice: 1.49,
currency: 'USD',
upc: '049000042566'
})
};
fetch('https://shelfforce.ai/api/v1/inventory/{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://shelfforce.ai/api/v1/inventory/{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([
'sku' => 'CC-330ML-CAN',
'brand' => 'Coca-Cola',
'name' => 'Coca-Cola Original 330ml Can',
'category' => 'Beverages',
'subcategory' => 'Carbonated Soft Drinks',
'sizeValue' => 330,
'sizeUnit' => 'ml',
'expectedPrice' => 1.49,
'currency' => 'USD',
'upc' => '049000042566'
]),
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://shelfforce.ai/api/v1/inventory/{id}"
payload := strings.NewReader("{\n \"sku\": \"CC-330ML-CAN\",\n \"brand\": \"Coca-Cola\",\n \"name\": \"Coca-Cola Original 330ml Can\",\n \"category\": \"Beverages\",\n \"subcategory\": \"Carbonated Soft Drinks\",\n \"sizeValue\": 330,\n \"sizeUnit\": \"ml\",\n \"expectedPrice\": 1.49,\n \"currency\": \"USD\",\n \"upc\": \"049000042566\"\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://shelfforce.ai/api/v1/inventory/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sku\": \"CC-330ML-CAN\",\n \"brand\": \"Coca-Cola\",\n \"name\": \"Coca-Cola Original 330ml Can\",\n \"category\": \"Beverages\",\n \"subcategory\": \"Carbonated Soft Drinks\",\n \"sizeValue\": 330,\n \"sizeUnit\": \"ml\",\n \"expectedPrice\": 1.49,\n \"currency\": \"USD\",\n \"upc\": \"049000042566\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://shelfforce.ai/api/v1/inventory/{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 \"sku\": \"CC-330ML-CAN\",\n \"brand\": \"Coca-Cola\",\n \"name\": \"Coca-Cola Original 330ml Can\",\n \"category\": \"Beverages\",\n \"subcategory\": \"Carbonated Soft Drinks\",\n \"sizeValue\": 330,\n \"sizeUnit\": \"ml\",\n \"expectedPrice\": 1.49,\n \"currency\": \"USD\",\n \"upc\": \"049000042566\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "inv_a1b2c3",
"updatedAt": "2026-02-23T11:00:00Z"
}
}{
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid or has been revoked."
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Analysis 'an_g7h8j9k0' not found."
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "The 'imageUrl' field must be a valid URL."
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred. Please try again or contact support with request ID."
}
}Authorizations
API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...
Headers
Unique key for idempotent requests. If a request with the same key was already processed within the last 24 hours, the cached response is returned with X-Idempotent-Replayed: true.
Example:
"idk_550e8400-e29b-41d4-a716-446655440000"
Path Parameters
Inventory item ID.
Example:
"inv_a1b2c3"
Body
application/json
Example:
"CC-330ML-CAN"
Example:
"Coca-Cola"
Example:
"Coca-Cola Original 330ml Can"
Example:
"Beverages"
Example:
"Carbonated Soft Drinks"
Example:
330
Example:
"ml"
Example:
1.49
Example:
"USD"
Example:
"049000042566"
Response
Inventory item updated.
Show child attributes
Show child attributes