Skip to main content
GET
/
api
/
v1
/
customer
/
orders
List Orders
curl --request GET \
  --url https://api.example.com/api/v1/customer/orders
{
  "data": [
    {
      "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "checkoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "soldById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalProvider": "<string>",
      "externalProviderId": "<string>",
      "code": "<string>",
      "amount": 123,
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "limit": 10,
    "page": 1,
    "totalItems": 142,
    "totalPages": 15
  }
}

Query Parameters

​
limit
number
default:10

Items per page.

Required range: 1 <= x <= 100
​
page
number
default:1

Page number.

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

Order status.

Available options:
PENDING,
PAID,
PAYMENT_FAILED,
CANCELED
​
type
enum<string>

Order type.

Available options:
ONLINE,
POS
​
createdAt
string

Created date range using operators separated by semicolon.

​
sortBy
enum<string>
default:createdAt

Field to sort by.

Available options:
createdAt,
amount,
status
​
sortOrder
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

OK

​
data
object[]
required
​
meta
object
required

Page-based pagination metadata.