Update Inventory

POST 
/products/inventory

The Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock purchase settings for multiple items in the inventory.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
itemsobject[]required

Array of items to update in the inventory.

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "items": [
    {
      "priceId": "5e9f8f8f8f8f8f8f8f8f8f8",
      "availableQuantity": 10,
      "allowOutOfStockPurchases": false
    }
  ]
}

application/json

Successful response

application/json

Schema

Schema

statusbooleanrequired

Status of api action

messagestring

Success message

Example (auto)

{
  "status": true,
  "message": "Successfully created"
}