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

status
enum<string>

Only orders in this status.

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

Only orders paid with this payment method, by its name in the payment methods list.

Example:

"stripe"

An order's ID, or part of a buyer's email.

sort
enum<string>
default:created_at

What the list is ordered by.

Available options:
created_at,
amount,
email,
status
direction
enum<string>
default:desc

Which way it is ordered.

Available options:
asc,
desc
range
enum<string>

Only orders placed in this period.

Available options:
today,
yesterday,
7d,
30d,
this_week,
last_week,
this_month,
last_month,
this_year
from
string

Only orders placed on or after this day, as YYYY-MM-DD. With to, in place of range.

Example:

"2026-10-01"

to
string

Only orders placed on or before this day, as YYYY-MM-DD.

Example:

"2026-10-31"

tz
string

The time zone the days of range, from and to are in, as an IANA name. Left out, UTC.

Example:

"Europe/Berlin"

rows
enum<string>
default:orders

What a row is: an order, or one product line of one.

Available options:
orders,
lines
check
enum<string>

1 for how many rows the file would have, as { rows }, in place of the file. Not counted against the store's exports, and refused with 429 where none are left.

Available options:
1

Response

The file itself, not a JSON envelope.

The response is of type file.