Skip to main content
cURL

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Query Parameters

limit
integer

Page size: default 25, at most 100.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Bound to the query, the workspace and the key.

Body

application/json
shop_id
string[]

Only these connected shops, comma-separated; default every connected shop of the workspace. A shop outside the workspace is 404.

from
string

Placed at or after this time (a date is midnight UTC).

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}(:\d{2}(\.\d{1,3})?)?(Z|[+-]\d{2}:\d{2}))?$
to
string

Placed before this time.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}(:\d{2}(\.\d{1,3})?)?(Z|[+-]\d{2}:\d{2}))?$
status
string[]

Only orders in these statuses, comma-separated: paid, completed, open, payment_processing, canceled, fully_refunded, partially_refunded (an open set: a status Etsy adds later works the same way).

listing_id
string

Only orders that include this listing. A listing outside the workspace is 404.

Pattern: ^[0-9]{1,20}$
buyer_id
string

Only this buyer's orders (the Etsy buyer's user ID). A buyer with no order in the selected shops is 404.

Pattern: ^[0-9]{1,20}$
sort
enum<string>

-created (newest first, the default) or created; ties go by order ID.

Available options:
-created,
created
shipped
boolean

true: only shipped orders; false: only orders not shipped yet.

q
string

A buyer name (case-insensitive, any part) or an exact order ID.

Response

OK

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
total
object
required
summary
object
required