Skip to main content
GET
Sales by company report

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

order_date[gte]
string<date>
required

Start of the order-date range (inclusive, YYYY-MM-DD).

order_date[lte]
string<date>
required

End of the order-date range (inclusive, YYYY-MM-DD). Must be on or after order_date[gte].

group_by
enum<string>
default:sku

How to group the per-company item breakdown. sku includes a sku field on each item; product aggregates by product.

Available options:
sku,
product
company_id[eq]
integer

Restrict the report to a single company.

company_id[in]
string

Restrict the report to a comma-separated list of company IDs (e.g. 1,2,3).

page
integer
default:1

Page number for pagination.

Required range: x >= 1
per_page
integer
default:10

Number of companies per page (max 100).

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
meta
object