Overview

The consumption endpoint GET /inventory/transactions/consumption returns usage from sales (including kit components), completed assemblies and disassemblies, and posted negative inventory adjustments. By default it groups by day and product, which is a company-wide total. Use the options below to break usage out by warehouse.

Group by warehouse

Add the group parameter:

  • group=product_warehouse returns one row per product per warehouse, with all dates combined. This suits average-daily-usage and reorder calculations.
  • group=day_product_warehouse returns one row per day, product and warehouse.

Each row has warehouse.id, warehouse.name and warehouse.type, plus quantity, total_cost and unit_cost.

Understand warehouse.type

Sales orders record only a warehouse group. Assemblies, disassemblies and adjustments record a physical warehouse. warehouse.type is warehouse_group or warehouse. A group and a warehouse can share the same numeric ID, so check the type before you match rows to a warehouse. Consumption with no warehouse assigned shows ID 0 and the name "No Warehouse Assigned".

Filter to specific warehouse groups

Use the warehouse_group.id filter, for example warehouse_group.id[in]=2 or warehouse_group.id=2. The export uses the same filter. Parameters named warehouse_id, warehouse_ids and warehouse.id are not supported and are ignored.

Limit by date

Use date[gte]=YYYY-MM-DD and date[lte]=YYYY-MM-DD (date[eq] and date[between] also work).

Export

GET /inventory/transactions/consumption/export accepts group, date, warehouse_group.id, type and include_transfer_orders. With product_warehouse or day_product_warehouse, the file ends with a Warehouse Type column.

Example

/inventory/transactions/consumption?group=product_warehouse&warehouse_group.id[in]=2&date[gte]=2026-07-01&date[lte]=2026-09-30