Actions35
- Contact Actions
- Contact Custom Field Actions
- Order Actions
- Order Custom Field Actions
- Order Note Actions
- Order Row Actions
- Price List Actions
- Product Actions
- Warehouse Actions
Warehouse → Get Product Availability
AI-generatedSummary
Retrieves product availability from Brightpearl for the specified product IDs, optionally including allocation, transfer, location, and purchase-order details. Can filter each product’s location breakdown to one warehouse.
Inputs
- Authentication — Choose OAuth2 or Private App authentication; defaults to Private App.
- Product IDs (required) — Brightpearl product IDs in single-ID, ascending range, or comma-separated-list syntax. Brightpearl caps requests at roughly 100 IDs per call.
- Include Optional Data — Select optional response sections: allocated orders, allocated transfers, per-location stock breakdown, and quantities on incoming purchase orders. Leave empty for the default summary payload.
- Warehouse ID — Optional client-side filter for the location breakdown. Setting an ID automatically requests per-location data and removes other warehouses from each product’s response; leave at 0 to include all warehouses.
Output shape
Availability data for the requested products.
Optional sections depend on the selections. When a warehouse ID is set, results are filtered to that warehouse.