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

page
integer
default:1

Which page of the list. The first is 1.

perPage
integer
default:50

How many a page holds, up to 100.

keyId
string

Only requests made with this API key.

method
enum<string>

Only requests of this method.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
status
string

Only requests that worked (ok), that were refused or failed (failed), or with one status code (404).

Example:

"failed"

A request's ID, or part of a path.

Response

It worked.

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