Update product inventory
curl --request PATCH \
--url https://production-api.puppetvendors.com/products/{productId}/inventory \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"variants": [
{
"variantId": "<string>",
"locationId": "<string>",
"quantity": 0,
"inventoryItemId": "<string>",
"compareQuantity": 123
}
],
"mode": "set",
"reason": "<string>"
}
'import requests
url = "https://production-api.puppetvendors.com/products/{productId}/inventory"
payload = {
"variants": [
{
"variantId": "<string>",
"locationId": "<string>",
"quantity": 0,
"inventoryItemId": "<string>",
"compareQuantity": 123
}
],
"mode": "set",
"reason": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
variants: [
{
variantId: '<string>',
locationId: '<string>',
quantity: 0,
inventoryItemId: '<string>',
compareQuantity: 123
}
],
mode: 'set',
reason: '<string>'
})
};
fetch('https://production-api.puppetvendors.com/products/{productId}/inventory', 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://production-api.puppetvendors.com/products/{productId}/inventory",
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([
'variants' => [
[
'variantId' => '<string>',
'locationId' => '<string>',
'quantity' => 0,
'inventoryItemId' => '<string>',
'compareQuantity' => 123
]
],
'mode' => 'set',
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$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://production-api.puppetvendors.com/products/{productId}/inventory"
payload := strings.NewReader("{\n \"variants\": [\n {\n \"variantId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 0,\n \"inventoryItemId\": \"<string>\",\n \"compareQuantity\": 123\n }\n ],\n \"mode\": \"set\",\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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://production-api.puppetvendors.com/products/{productId}/inventory")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"variants\": [\n {\n \"variantId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 0,\n \"inventoryItemId\": \"<string>\",\n \"compareQuantity\": 123\n }\n ],\n \"mode\": \"set\",\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/products/{productId}/inventory")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"variants\": [\n {\n \"variantId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 0,\n \"inventoryItemId\": \"<string>\",\n \"compareQuantity\": 123\n }\n ],\n \"mode\": \"set\",\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"updated": 123,
"errors": [
{
"variantId": "<string>",
"message": "<string>"
}
]
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Products
Update product inventory
Set or adjust inventory per variant and location. Each variant succeeds or fails on its own: the call returns 200 and lists any failed variants in data.errors. Requires the admin:products:write permission.
PATCH
/
products
/
{productId}
/
inventory
Update product inventory
curl --request PATCH \
--url https://production-api.puppetvendors.com/products/{productId}/inventory \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"variants": [
{
"variantId": "<string>",
"locationId": "<string>",
"quantity": 0,
"inventoryItemId": "<string>",
"compareQuantity": 123
}
],
"mode": "set",
"reason": "<string>"
}
'import requests
url = "https://production-api.puppetvendors.com/products/{productId}/inventory"
payload = {
"variants": [
{
"variantId": "<string>",
"locationId": "<string>",
"quantity": 0,
"inventoryItemId": "<string>",
"compareQuantity": 123
}
],
"mode": "set",
"reason": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
variants: [
{
variantId: '<string>',
locationId: '<string>',
quantity: 0,
inventoryItemId: '<string>',
compareQuantity: 123
}
],
mode: 'set',
reason: '<string>'
})
};
fetch('https://production-api.puppetvendors.com/products/{productId}/inventory', 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://production-api.puppetvendors.com/products/{productId}/inventory",
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([
'variants' => [
[
'variantId' => '<string>',
'locationId' => '<string>',
'quantity' => 0,
'inventoryItemId' => '<string>',
'compareQuantity' => 123
]
],
'mode' => 'set',
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$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://production-api.puppetvendors.com/products/{productId}/inventory"
payload := strings.NewReader("{\n \"variants\": [\n {\n \"variantId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 0,\n \"inventoryItemId\": \"<string>\",\n \"compareQuantity\": 123\n }\n ],\n \"mode\": \"set\",\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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://production-api.puppetvendors.com/products/{productId}/inventory")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"variants\": [\n {\n \"variantId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 0,\n \"inventoryItemId\": \"<string>\",\n \"compareQuantity\": 123\n }\n ],\n \"mode\": \"set\",\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/products/{productId}/inventory")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"variants\": [\n {\n \"variantId\": \"<string>\",\n \"locationId\": \"<string>\",\n \"quantity\": 0,\n \"inventoryItemId\": \"<string>\",\n \"compareQuantity\": 123\n }\n ],\n \"mode\": \"set\",\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"updated": 123,
"errors": [
{
"variantId": "<string>",
"message": "<string>"
}
]
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}{
"success": false,
"error": {
"message": "Resource not found",
"code": "NOT_FOUND",
"errorId": "err_1783365360839_j281w7b",
"details": {}
}
}Authorizations
JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.
Path Parameters
A product ObjectId, a Shopify product GID or a numeric Shopify product id. Malformed is 400.
Body
application/json
Was this page helpful?