Skip to main content
GET

Get stock levels for a warehouse

Scope:inventory:warehouses.read
https://api.holded.com/api/v2/warehouses/{warehouseId}/stock

Returns the stock levels for all products stored in a specific warehouse. The response includes each product's ID, variant ID (if applicable), and current stock quantity. Use this endpoint to audit inventory or synchronize stock with external systems.

Parameters

Path parameters

warehouseIdstringrequired

Warehouse ID (24-char hex ObjectId)

Request

python
import requests

url = "https://api.holded.com/api/v2/warehouses/{warehouseId}/stock"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

json
{
  "items": [
    {
      "product_id": "string",
      "variant_id": "string",
      "stock": "15.3"
    }
  ],
  "cursor": "string",
  "has_more": false
}

Success responses

200Stock items for the warehouseapplication/json
object
items[]object[]
product_idstring

Identifier of the product

variant_idstring | null

Identifier of the product variant, if applicable

stockstring

Current stock quantity in this warehouse as a decimal string

cursorstring | null
has_moreboolean

Error responses

401Invalid or missing API keyapplication/json
403Insufficient permissionsapplication/json
404Warehouse not foundapplication/json
429Rate limit exceededapplication/json