Skip to content
docs
Guides
ES
Carts & CheckoutCustomer

List customer orders

Paginated customer order history with items, shipping address and payment totals

GET/v1/customer/orders

Paginated customer order history with items, shipping address and payment totals

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"

Header Parameters

Authorization*string

OAuth 2.0 bearer token.

x-Store-Domain*string

Store slug or configured domain that selects the store context at the central Storefront gateway.

Length1 <= length <= 253

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/customer/orders" \  -H "Authorization: Bearer <token>" \  -H "x-Store-Domain: my-store"
{  "data": [    {      "orderId": "7204558912004325301",      "orderNumber": "ORD-2026-0001",      "orderGroup": "example",      "orderIds": [        "example"      ],      "status": "new",      "total": 1,      "totalPaid": 1,      "currencyCode": "PEN",      "orderDate": "2026-08-01T15:30:00Z",      "createdOn": "2026-08-01T15:30:00Z",      "updatedOn": "2026-08-01T15:30:00Z",      "paymentAt": "2026-08-01T15:30:00Z",      "shippingAddress": {        "address1": "example",        "city": "example",        "countryCode": "PE",        "name": "Example resource",        "company": "example",        "address2": "example",        "province": "example",        "postalCode": "example_code"      },      "shippingAddressSummary": "example",      "items": [        {          "id": "7204558912004325301",          "orderId": "7204558912004325301",          "productId": "7204558912004325301",          "variantId": "7204558912004325301",          "title": "Example title",          "subtitle": "Example title",          "thumbnail": "example",          "variantTitle": "Example title",          "productHandle": "example",          "quantity": 1,          "unitPrice": 1,          "total": 1,          "status": "new"        }      ]    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}