Sales overview
Orders, gross and net sales, and average order value for a period, in Riyadh time.
GET/stores/{storeId}/v1/analytics/overview
from and to use YYYY-MM-DD, both are required, and the period is 1 to 366 days. These are the same figures the merchant sees in the dashboard.
Query parameters
- fromstring (date)required
- tostring (date)required
Response
- dataobjectrequired
- ordersinteger
- paid_ordersinteger
- fulfilled_ordersinteger
- gross_salesstring
- Gross sales.
- wallet_refundsstring
- Refunded to the customer wallet.
- net_salesstring
- Net sales.
- average_orderstring
- Average order value.
- currencyobject
- executionobject
- Who executed the request: the app, version, installation and store. Field names here are camelCase.
- appIdstring (uuid)
- versionIdstring (uuid)
- installationIdstring (uuid)
- storeIdstring (uuid)
- requestIdstring (uuid)
- generationinteger
- routeEpochinteger
- appAuthEpochinteger
- grantRevisioninteger
- metaobjectrequired
- metric_definitionobject
- timezoneobject
- fromstring (date)
- tostring (date)
- currencyobject
- request_idstring (uuid)
Errors
| HTTP | Code | Meaning |
|---|
| 400 | INVALID_DATE_RANGE | Missing date, or a period longer than 366 days. |
Shared codes are listed in Errors.
