Skip to main content

​
List Orders

GET /api/v1/orders Returns a paginated list of orders for the authenticated user with optional filtering.

​
Query Parameters

ParameterTypeDefaultDescription
per_pageinteger15Number of items per page (max: 100)
fulfillment_statusstring—Filter by fulfillment status: pending, processing, completed, refunded
payment_statusstring—Filter by payment status: pending, completed

​
Responses

StatusDescription
200 OKSuccessful operation
401 UnauthorizedMissing or invalid authentication token
403 ForbiddenAccess denied

​
Example Response

{
  "data": [
    {
      "id": 12345,
      "ulid": "01J9Z3NDEKTSV4RRFFQ69G5FAV",
      "order_number": "#ORD-12345",
      "fulfillment_status": "completed",
      "payment_status": "completed",
      "subtotal": { "amount": 99.99, "formatted": "€99.99" },
      "conversion_fees": { "amount": 2.5, "formatted": "€2.50" },
      "total": { "amount": 102.49, "formatted": "€102.49" },
      "currency": "EUR",
      "items": [],
      "created_at": "2023-01-01T12:00:00+00:00",
      "updated_at": "2023-01-01T12:00:00+00:00"
    }
  ],
  "links": {
    "first": "https://api.example.com/orders?page=1",
    "last": "https://api.example.com/orders?page=5",
    "prev": null,
    "next": "https://api.example.com/orders?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "path": "https://api.example.com/orders",
    "per_page": 15,
    "to": 15,
    "total": 75
  }
}