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

q
string

Only what matches this text: an order's ID, a reseller's website, or who bought or paid.

reseller
string

Only one reseller's, by their ID.

via
enum<string>

Only those bought one way.

Available options:
panel,
api,
url
page
integer
default:1

Which page of the list. The first is 1.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object[]
pages
integer
total
integer
meta
object