Skip to main content
GET
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Query Parameters

range
string
default:30d

The period: today, 7d, 30d, this_month, last_month, this_year, custom with from and to, or all.

from
string

With range custom: the first day, as YYYY-MM-DD.

to
string

With range custom: the last day, as YYYY-MM-DD.

tz
string

The time zone the days are read in, as an IANA name. Left out, UTC.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object[]
meta
object