Skip to main content
GET
List orders to ship

Authorizations

x-api-key
string
header
required

Your Store API key (pk_live_...). Create it in Developers › API keys.

x-store-hash
string
header
required

The ID of the store the request is for. Shown in Developers › API keys.

Query Parameters

status
enum<string>
default:all
Available options:
to_ship,
in_transit,
delivered,
issues,
all
q
string

Order ID, email, name or tracking number.

limit
integer
default:25

Items per page (1–100).

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip.

Required range: x >= 0

Response

A page

success
boolean
required
Example:

true

orders
object[]
counts
object
pagination
object
page
integer
limit
integer
total
integer