API: `syncInventory`
Product.variant_combinations or the modifier_id.POST /v1/syncInventoryRequest Payload
| Key | Type | Description |
|---|---|---|
command | string | The action to perform: "update". |
info | object | The full Inventory data object, including variant_combination_sku or modifier_id as applicable. |
Sample Request Body
TSHIRT-L-RD) and simultaneously marking a modifier (mod_gift_wrap) as unavailable for another product.{
"inventory": [
{
"command": "update",
"info": {
"id": "inv_TSHIRT-L-RD", // Assumes an ID exists or can be derived
"product_id": "prod_retail_tshirt",
"variant_combination_sku": "TSHIRT-L-RD", // Target specific variant combo
"modifier_id": null,
"quantity": 15,
"is_in_stock": true,
"updated_at": "2025-10-18T20:00:00Z"
}
},
{
"command": "update",
"info": {
"id": "inv_other_prod_mod_giftwrap", // Assumes an ID exists
"product_id": "prod_some_other_product", // ID of product with gift wrap
"variant_combination_sku": null, // Modifier applies regardless of variant
"modifier_id": "mod_gift_wrap", // Target specific modifier
"quantity": null,
"is_in_stock": false, // Mark as unavailable
"updated_at": "2025-10-18T20:01:00Z"
}
}
]
}Response Payload
Sample Error Response
{
"status": "partial_failure",
"errors": [
{
"id": "inv_TSHIRT-L-RD", // Corresponds to the ID sent in the request's info object
"error": {
"code": "INVALID_SKU",
"message": "variant_combination_sku 'TSHIRT-L-RD' does not exist for product_id 'prod_retail_tshirt'."
}
}
// Succeeded operations are not listed
]
}