List orders
Newest first (created_at, then id). Paged by keyset: follow
next_cursor for an infinite list; orders placed meanwhile never shift
or repeat rows, whatever the filters. Page-number tables may pass
offset instead (with include_total=true for the page count).
Each row carries what a list or card needs (status, customer, totals, first item, unit counts, per-line shipped counts); fetch the order for the rest.
Authorization
bearer_auth Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.
In: header
Path Parameters
Store id
uuidQuery Parameters
An order status, or processing / shipped (the fulfillment tabs).
"draft" | "pending" | "paid" | "fulfilled" | "cancelled" | "refunded" | "processing" | "shipped"Only this customer's orders.
uuidMatches the order number, the customer's name or e-mail, and the name or e-mail typed at checkout.
Include orders flagged as test data. Defaults to false.
Only orders created at or after this instant.
date-timeOnly orders created before this instant.
date-timePage size, 1 to 200. Defaults to 50.
int641 <= value <= 200next_cursor from the previous page. Omit for the first page.
Rows to skip, for UIs that jump to a page number. Ignored when
cursor is set. Prefer cursor for walking a whole list.
int640 <= valueAlso return total, the count of all matching rows. Costs an extra
query; leave off when you only walk pages.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/orders?limit=50"{
"data": [
{
"created_at": "2019-08-24T14:15:22Z",
"currency": "string",
"customer_email": "string",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"customer_name": "string",
"discount_cents": 0,
"first_item_image": "string",
"first_item_title": "string",
"freight_provider_code": "string",
"freight_status": "string",
"fulfillment_method": "string",
"fulfillment_status": null,
"has_nfe": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_test": true,
"item_count": 0,
"number": "string",
"ordered_units": 0,
"payment_expires_at": "2019-08-24T14:15:22Z",
"payment_intent_status": null,
"payment_status": null,
"shipment_items": [
{
"quantity": 0,
"shipped": 0,
"sku": "string",
"title": "string"
}
],
"shipped_units": 0,
"shipping_cents": 0,
"status": "draft",
"store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
"subtotal_cents": 0,
"tax_cents": 0,
"total_cents": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"has_more": true,
"next_cursor": "string",
"total": 0
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}