Skip to content

Get one order by id

GET
/orders/{order_id}
curl --request GET \
--url https://api.fleet.co/platform/v1/orders/42 \
--header 'Authorization: Bearer <token>'

Returns validated orders only, like GET /orders; read a cart with GET /carts/{order_id}.

order_id
required

Order id

string
/^[1-9]\d*$/

Example

42

Order

Media typeapplication/json
object
data
required
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
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
fulfillment_mode
required

DIRECT_DELIVERY ships devices to their users; STOCK ships them to the company’s stock

string
Allowed values: DIRECT_DELIVERY STOCK
created_at
required
string
nullable
updated_at
required
string
nullable

Example

{
"data": {
"client_status": "RECEIVED",
"fulfillment_mode": "DIRECT_DELIVERY"
}
}

Validation error

Media typeapplication/json
object
message
required

Every validation failure, comma-separated

string
type
required
string
Allowed values: validation_error
error
required
string
Allowed values: validation_error

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

Unauthorized

Not found

Media typeapplication/json
object
error
required
string
Allowed values: ORDER_NOT_FOUND

Example

{
"error": "ORDER_NOT_FOUND"
}

Rate 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
Allowed values: INTERNAL_ERROR

Example

{
"error": "INTERNAL_ERROR"
}

Rate limiting is temporarily unavailable; retry with backoff

Media typeapplication/json
object
message
required
string

Example generated

{
"message": "example"
}