List Orders

GET/store/:storeCode/orders

publishable keyJWT

Retrieve paginated orders for the logged-in customer.

Path Parameters

storeCoderequiredstring

Store slug in the URL (first argument to every SDK store method).

Query Parameters

limitnumber

Maximum number of items to return.

offsetnumber

Number of items to skip before collecting the result set.

orderstring

Field to sort by. Prefix with `-` for descending order (e.g. `-created_at`).

fieldsstring

Comma-separated fields to include. Prefix with `*` to expand a relation (e.g. `id,*variants`).

idstring | string[]

Filter by order ID(s).

statusOrderStatus | OrderStatus[]

Filter by status: `"pending"`, `"completed"`, `"draft"`, `"archived"`, `"canceled"`, `"requires_action"`.

Response

Status

200OK

Schema

Copy

HttpTypes.StoreOrderListResponse

Properties

ordersrequiredStoreOrder[]

List of orders.

countrequirednumber

Total count.

offsetrequirednumber

Offset applied.

limitrequirednumber

Limit applied.