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:20

How many a page holds, up to 100.

status
enum<string>

Only invoices whose order is in this status.

Available options:
pending,
completed,
refunded,
cancelled,
chargeback

An invoice's number, part of a buyer's email or name, or part of what a payment link is for.

kind
enum<string>

Only invoices written for a buyer, or only payment links.

Available options:
invoice,
link

Response

It worked.

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