Skip to main content
GET
/
v1
/
orders
List orders
curl --request GET \
  --url https://api-eu.flexportal.io/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-ID: <tenant-id>'
{
  "orders": [
    {
      "orderId": "<string>",
      "tenantId": "<string>",
      "status": "pending",
      "orderType": "standard",
      "customer": {
        "customerId": "<string>",
        "email": "jsmith@example.com",
        "firstName": "<string>",
        "lastName": "<string>",
        "company": "<string>",
        "phone": "<string>",
        "customerType": "individual"
      },
      "billingAddress": {
        "contactName": "<string>",
        "streetAddress": "<string>",
        "city": "<string>",
        "country": "<string>",
        "company": "<string>",
        "buildingInfo": "<string>",
        "locality": "<string>",
        "adminArea": "<string>",
        "postalCode": "<string>"
      },
      "shippingAddress": {
        "contactName": "<string>",
        "streetAddress": "<string>",
        "city": "<string>",
        "country": "<string>",
        "company": "<string>",
        "buildingInfo": "<string>",
        "locality": "<string>",
        "adminArea": "<string>",
        "postalCode": "<string>"
      },
      "items": [
        {
          "sku": "<string>",
          "productName": "<string>",
          "quantity": 2,
          "unitPrice": 1,
          "contractLength": 123,
          "rentalIds": [],
          "rentalStatus": "pending"
        }
      ],
      "totals": {
        "subtotal": 1,
        "total": 1,
        "currency": "<string>",
        "totalDevices": 2,
        "taxAmount": 0
      },
      "rentalProgress": {
        "totalDevices": 1,
        "rentedDevices": 1
      },
      "rentalIds": [
        "<string>"
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": "<string>",
      "payment": {
        "status": "pending",
        "method": "stripe",
        "transactionId": "<string>",
        "paidAmount": 1,
        "manuallyMarked": false
      },
      "customFields": {},
      "billingGroupId": "<string>",
      "trackingNumber": "<string>",
      "shippedAt": "<string>",
      "notes": "<string>",
      "extensionDetails": {
        "originalOrderId": "<string>",
        "extensionMonths": 123,
        "previousEndDate": "<string>",
        "newEndDate": "<string>",
        "reason": "<string>"
      },
      "upgradeDetails": {
        "previousDevice": "<string>",
        "previousSerialNumber": "<string>",
        "previousMonthlyAmount": 123,
        "previousRentalId": "<string>",
        "upgradeReason": "<string>"
      }
    }
  ],
  "count": 123,
  "limit": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Query Parameters

limit
string

Items per page (default: 50, max: 100)

startAfter
string

Cursor for pagination

status
string

Filter by status (pending, confirmed, partial, fulfilled, cancelled)

customerId
string

Filter by customer ID

Response

200 - application/json

List of orders

orders
object[]
required
count
number
required
limit
number
required
hasMore
boolean
required
nextCursor
string | null
required