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>"
}
}Retrieves a specific order by ID.
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>"
}
}API key obtained from FlexPortal dashboard
Your tenant identifier
The order ID
Order details
pending, confirmed, partial, fulfilled, cancelled standard, extension, upgrade Show child attributes
111individual, business Show child attributes
Show child attributes
Show child attributes
11x >= 1x >= 0pending, partial, completed