Tool to retrieve a list of inventory breakdowns filtered by status and product/product group. Use when you need to analyze inventory allocation across locations. Note: Both status filter and either product_id or product_group_id filter are required.
sortstringSort results by field. Prefix with '-' for descending order.
fieldsarraySpecify which fields to return in the response.
includestringComma-separated list of related resources to include. Available: product, location, inventory_levels.
page_sizeintegerNumber of items per page, must be >= 1.
page_numberintegerPage number for pagination, must be >= 1.
filter_statusRequiredstringStatus of inventory breakdowns to retrieve. This is a required filter.
filter_product_idstringFilter by specific product ID. Either product_id or product_group_id must be specified.
filter_product_group_idstringFilter by product group ID. Either product_id or product_group_id must be specified.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.