List orders
GET
/orders
const url = 'https://api.fleet.co/platform/v1/orders?limit=50&offset=0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.fleet.co/platform/v1/orders?limit=50&offset=0' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”limit
Page size (max 100)
integer
Example
50offset
Number of items to skip
integer
Example
0Responses
Section titled “Responses”Paginated orders
Media typeapplication/json
object
data
required
Array<object>
object
order_id
required
integer
client_status
required
Order progress key for display and filtering
string
device_names
required
Display names for devices on the order
Array<string>
rent
required
string
rent_currency
required
string
order_number
required
string
contract_number
required
string
order_date
required
string
num_devices
required
integer
fulfillment_mode
required
DIRECT_DELIVERY ships devices to their users; STOCK ships them to the company’s stock
string
created_at
required
string
updated_at
required
string
meta
required
object
total
required
Total items matching filters (before paging)
integer
limit
required
Page size used for this response
integer
offset
required
Offset used for this response
integer
Example
{ "data": [ { "client_status": "RECEIVED", "fulfillment_mode": "DIRECT_DELIVERY" } ], "meta": { "total": 42, "limit": 50, "offset": 0 }}Validation error
Media typeapplication/json
object
message
required
Every validation failure, comma-separated
string
type
required
string
error
required
string
Example
{ "message": "Required, must be an ISO 3166-1 alpha-2 country code", "type": "validation_error", "error": "validation_error"}Missing, invalid, or revoked API key
Media typetext/plain
string
Example
UnauthorizedRate limit exceeded. The RateLimit-* headers give the limit and the reset time.
Media typetext/plain
string
Example
Too many requests, please try again later.Unexpected server error
Media typeapplication/json
object
error
required
string
Example
{ "error": "INTERNAL_ERROR"}Rate limiting is temporarily unavailable; retry with backoff
Media typeapplication/json
object
message
required
string
Example generated
{ "message": "example"}
