Skip to content
Fleet Fleet Platform API

List orders

GET
/orders

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit

Page size (max 100)

integer
default: 50 >= 1 <= 100
Example
50
offset

Number of items to skip

integer
0 nullable
0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated orders

object
data
required
Array<object>
object
order_id
required
integer
client_status
required

Order progress key for display and filtering

string
Allowed values: RECEIVED BEING_PROCESSED FINANCING_REQUEST DOC_REQUIRED SIGNING PROCESSING SHIPPED RECEPTION_TO_CONFIRM ONGOING_ORDER PENDING_DECISION EQUIPMENT_TO_SEND ARCHIVED FAILED UNKNOWN
Example
BEING_PROCESSED
device_names
required

Display names for devices on the order

Array<string>
rent
required
string
nullable
rent_currency
required
string
nullable
order_number
required
string
nullable
contract_number
required
string
nullable
order_date
required
string
nullable
num_devices
required
integer
nullable
meta
required
object
total
required

Total rows matching filters (before paging)

integer
Example
42
limit
required

Requested page size after validation

integer
Example
50
offset
required

Requested offset after validation

integer
0