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.

status
enum<string>

Only those in one state.

Available options:
paid,
waiting,
checking,
expired,
taken_back
check
enum<string>

1 for how many rows the file would have, as { rows }, in place of the file.

Available options:
1

Response

The file itself, not a JSON envelope.

The response is of type file.