Skip to main content
GET
Get an order

Overview

Retrieve complete details for a single order by its ID. Use this endpoint to display order details, check fulfillment status, or verify order contents before creating subscriptions.

Common Use Cases

  • Order Details Page: Display complete order information to customers or staff
  • Pre-Fulfillment Check: Verify order contents and customer details before creating subscriptions
  • Status Tracking: Check if an order has been fully fulfilled
  • Invoice Generation: Get order totals and line items for invoicing

Order Lifecycle

Orders progress through these statuses:

Understanding Order Items

Each item in the items array represents a product line in the order:

Fulfillment Progress

The rentalProgress field shows overall fulfillment status:
When rentedDevices equals totalDevices, the order status changes to fulfilled.

Cost Tracking Fields

For cost recovery and profitability tracking:

Example: Check if Order is Ready for Fulfillment

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 | null
billingGroupId
string
trackingNumber
string
shippedAt
string
notes
string
extensionDetails
object
upgradeDetails
object