Update stock settings

Update reorder settings for a product in a warehouse

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

warehouseId*string

Warehouse ID

productId*string

Product ID

Header Parameters

x-business-id*string

Business ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

minStockLevel?number

Minimum stock level - alert when below this

maxStockLevel?number

Maximum optimal stock level

reorderPoint?number

Reorder point - when to reorder

reorderQuantity?number

Suggested reorder quantity

classification?string

Stock classification

Value in

"available"
"damaged"
"slow_moving"
"obsolete"
"reserved"
"consignment_in"
"consignment_out"

Response Body

`application/json`

curl -X PUT "https://example.com/inventory/stock/warehouse/string/product/string/settings" \  -H "x-business-id: string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "warehouseId": "string",  "warehouseName": "string",  "productId": "string",  "productName": "string",  "productSku": "string",  "productBarcode": "string",  "quantity": 0,  "reservedQuantity": 0,  "availableQuantity": 0,  "incomingQuantity": 0,  "classification": "available",  "averageCost": 0,  "lastPurchaseCost": 0,  "totalCostValue": 0,  "minStockLevel": 0,  "maxStockLevel": 0,  "reorderPoint": 0,  "isLowStock": true,  "needsReorder": true,  "lastMovementAt": "2019-08-24T14:15:22Z",  "lastCountDate": "2019-08-24T14:15:22Z"}