Skip to main content
GET
Reports summary

Authorizations

Authorization
string
header
required

Authorization: Bearer

Query Parameters

months
enum<integer>
default:12

How many calendar months to cover, counting the current one. Exactly 3, 6 or 12; anything else, including 03 or 12.0, answers 422 invalid_parameter.

Available options:
3,
6,
12

Response

The summary for the range. Zeros and empty lists when there are no orders.

status
enum<string>
required
Available options:
success
status_code
integer
required
Example:

200

message
string
required
Example:

"OK"

data
object
required

One key named after the resource (products / product / states / categories / attributes / order / validation).

meta
object | null
required
error
object | null
required