Reports
Sales by items report
Retrieves the sales by items report.
GET
Headers
Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.
Example:
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Query Parameters
Start date for the sales by items report
Example:
"2024-01-01"
End date for the sales by items report
Example:
"2024-01-31"
Number of decimal places to display
Example:
2
Whether to divide the number by 1000
Example:
false
Whether to show zero values
Example:
true
How to format money values
Available options:
total, always, none Example:
"total"
How to format negative numbers
Available options:
parentheses, mines Example:
"parentheses"
Whether to exclude items with no transactions
Example:
false
Whether to include only active items
Example:
false
Array of item IDs to filter the sales report
Example:
[1, 2, 3]Response
200
Sales by items report