Skip to main content
GET
Consumption report (paginated)

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

group
enum<string>
default:day_product

Aggregation level for the data items. product_warehouse returns one row per product per warehouse / warehouse group with all dates in the range combined.

Available options:
day_product,
product,
day_product_warehouse,
product_warehouse,
transaction
date[gte]
string<date>

Only consumption on or after this transaction date (Y-m-d).

Example:

"2026-07-01"

date[lte]
string<date>

Only consumption on or before this transaction date (Y-m-d).

Example:

"2026-09-30"

date[eq]
string<date>

Only consumption on this transaction date (Y-m-d).

warehouse_group.id[eq]
integer

Only consumption attributed to this warehouse group. warehouse_group.id=2 is equivalent.

Example:

2

warehouse_group.id[in]
string

Comma-separated warehouse group IDs; consumption in any of them is counted.

Example:

"2,5"

warehouse_group.id[notin]
string

Comma-separated warehouse group IDs to exclude.

Example:

"7"

warehouse_id
integer

Only consumption for this physical warehouse. warehouse_id[eq]=2 is equivalent. Sales and kit rows match when the order's warehouse group includes the warehouse.

Example:

2

warehouse_id[in]
string

Comma-separated physical warehouse IDs; consumption in any of them is counted.

Example:

"2,5"

type
string

Comma-separated consumption sources to include (sale, assembly, disassembly, adjustment). Defaults to all four.

Example:

"sale,assembly"

include_transfer_orders
boolean
default:true

Set to 0 to exclude sales orders auto-generated from internal transfer orders.

per_page
integer
default:10

Number of items per page (max 1000)

Required range: x <= 1000
page
integer
default:1

Page number for pagination

Required range: x >= 1

Response

Consumption data with pagination metadata

data
object[]
meta
object