Skip to main content
GET
/
v1
/
orders
/
{orderId}
Get an order
curl --request GET \
  --url https://api-eu.flexportal.io/v1/orders/{orderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-ID: <tenant-id>'
{
  "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>"
  }
}

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Path Parameters

orderId
string
required

The order ID

Response

Order details

orderId
string
required
tenantId
string
required
status
enum<string>
required
Available options:
pending,
confirmed,
partial,
fulfilled,
cancelled
orderType
enum<string>
required
Available options:
standard,
extension,
upgrade
customer
object
required
billingAddress
object
required
shippingAddress
object
required
items
object[]
required
totals
object
required
rentalProgress
object
required
rentalIds
string[]
required
createdAt
string
required
updatedAt
string
required
createdBy
string
required
payment
object
customFields
object
billingGroupId
string
trackingNumber
string
shippedAt
string
notes
string
extensionDetails
object
upgradeDetails
object