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.

endpointId
string

Only deliveries to this endpoint.

event
string

Only deliveries of this event.

Example:

"order.paid"

state
enum<string>

Only deliveries in this state.

Available options:
pending,
delivered,
failed

A delivery's ID, an event's ID, or the ID of what the event is about, such as an order.

Response

It worked.

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