Skip to main content
GET
List orders
Returns the store’s orders most recent first, each enriched with the customer, payment, coupon and shipment summaries. The shipment summary includes the delivery address (shipment.shippingAddress) once the order has a shipment — no per-order detail fetch needed for bulk geographic or shipping-zone work. The store is bound to your app token server-side — never send a shop id.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

page
integer
default:1

Page number (1-based).

Required range: x >= 1
limit
integer
default:10

Number of orders per page.

Required range: x >= 1
status
enum<string>

Filter by order status. One of: pending, processing, paid, cancelled, refunded. Other values are ignored.

Available options:
pending,
processing,
paid,
cancelled,
refunded
user
string

Filter by the customer's user id (Mongo ObjectId). Invalid ids are ignored.

startDate
string<date-time>

Inclusive lower bound on order creation date (ISO 8601, filters createdAt).

endDate
string<date-time>

Inclusive upper bound on order creation date (ISO 8601, filters createdAt).

Response

Paginated list of orders.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object