Create external devices (batch)
const url = 'https://api.fleet.co/platform/v1/devices';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"devices":[{"name":"example","type":"DEVICE","category":"ACOUSTIC_CHAIR","user_id":1,"added_via":"MASS_IMPORT","is_rented":false,"brand":"apple","serial_number":"example","client_purchase_price":"1299.00","client_purchase_date":"2025-01-31","client_warranty_end_date":"2025-01-31","client_rental_price":"45.00","client_rental_start_date":"2025-01-31","client_rental_end_date":"2025-01-31","client_contract_number":"example","client_invoice_number":"example","screen_size":"example","graphic":"example","processor":"example","ram":"example","storage":"example","model_year":"example","connectivity":"example","resolution":"example","comment":"example","color":"example","seats_number":"example","assembly":"example","os_platform":"example","keyboard_layout":"FRENCH_AZERTY","has_microphone":true,"has_webcam":true,"noise_cancellation":true,"compliance":["example"],"connection_type":["example"],"has_stool":true,"has_video_package":true,"has_screen":true,"has_premium_tablet":true}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.fleet.co/platform/v1/devices \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "devices": [ { "name": "example", "type": "DEVICE", "category": "ACOUSTIC_CHAIR", "user_id": 1, "added_via": "MASS_IMPORT", "is_rented": false, "brand": "apple", "serial_number": "example", "client_purchase_price": "1299.00", "client_purchase_date": "2025-01-31", "client_warranty_end_date": "2025-01-31", "client_rental_price": "45.00", "client_rental_start_date": "2025-01-31", "client_rental_end_date": "2025-01-31", "client_contract_number": "example", "client_invoice_number": "example", "screen_size": "example", "graphic": "example", "processor": "example", "ram": "example", "storage": "example", "model_year": "example", "connectivity": "example", "resolution": "example", "comment": "example", "color": "example", "seats_number": "example", "assembly": "example", "os_platform": "example", "keyboard_layout": "FRENCH_AZERTY", "has_microphone": true, "has_webcam": true, "noise_cancellation": true, "compliance": [ "example" ], "connection_type": [ "example" ], "has_stool": true, "has_video_package": true, "has_screen": true, "has_premium_tablet": true } ] }'Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”object
object
Device family (device_type enum): DEVICE for computers, phones, tablets, and screens.
Example
DEVICEDevice category code (exact match to catalog / device_category enum). Use values such as COMPUTER or SCREEN — not display labels like Laptop.
Example
COMPUTERAssignee: a user of the company
Onboarding channel for the device.
Example
SINGLE_IMPORTTrue when the company rents the device elsewhere. Selects which client_* price and date fields are kept.
Lowercase brand, e.g. apple
Example
appleManufacturer serial number; checked against the brand’s format
Purchase price as a decimal string; kept only when is_rented is false
Example
1299.00Purchase date; kept only when is_rented is false
Example
2025-01-31Warranty end date; kept only when is_rented is false
Example
2025-01-31Monthly rent as a decimal string; kept only when is_rented is true
Example
45.00Rental start date; kept only when is_rented is true
Example
2025-01-31Rental end date; kept only when is_rented is true
Example
2025-01-31Keyboard layout key (same enum as cart/order keyboard_layout).
Example
FRENCH_AZERTYResponses
Section titled “Responses”Devices created
object
object
object
Company asset tag
Assigned user id; load the user with GET /users/:id
Company address where the device is kept once delivered
Company address of the first delivery
object
Where the device is now. IN_TRANSIT covers the first delivery and transfers; COMPANY_ADDRESS means it sits at assigned_address_id.
Company address of the location: the destination when IN_TRANSIT, the assigned address when COMPANY_ADDRESS. Null for Fleet-managed locations (repairer, Fleet storage, stock region, reconditioning).
Tracking page URL.
Initial delivery shipment date (ISO 8601).
Initial delivery completion date (ISO 8601).
Carrier-estimated initial delivery date (ISO 8601).
Device progress key for display and filtering
Free-form device comment
object
Keyboard layout code used for pricing and device configuration.
MDM enrollment details once enrollment has started; null otherwise
object
MDM enrollment status.
object
Order progress key for display and filtering
Display names for devices on the order
DIRECT_DELIVERY ships devices to their users; STOCK ships them to the company’s stock
Open repair; closed repairs are listed by GET /repairs?device_id=
object
Repair progress. COMPLETED and CANCELLED are closed repairs.
Tracking number of the pickup to the repairer
Tracking number of the return from the repairer
Company device lent during the repair
Current storage stay (ACTIVE or ENDING); past stays are listed by GET /storage-stays?device_id=
object
ACTIVE: stored at Fleet. ENDING: on its way back. ENDED: delivered back. CANCELLED: never stored.
Country of the Fleet storage (ISO alpha-2)
Whether the device was factory reset on intake
Condition graded on intake
Shipment to the storage; listed in the device parcels
Shipment out of the storage; listed in the device parcels
Return and inter-office shipments for this device, newest first. Initial delivery uses the device tracking_number and tracking_url. Load addresses with GET /addresses/:id.
object
RETURN: device return shipment. INTER_OFFICE_DELIVERY: inter-office move.
Parcel shipment progress. CANCELLED: the shipment was called off before delivery.
Tracking page URL.
Example
{ "data": { "devices": [ { "location": { "type": "NONE" }, "client_status": "ARCHIVED", "characteristics": { "keyboard_layout": "FRENCH_AZERTY" }, "mdm": { "status": "SUBSCRIBED" }, "order": { "client_status": "RECEIVED", "fulfillment_mode": "DIRECT_DELIVERY" }, "repair": { "status": "REQUEST_RECEIVED" }, "storage": { "status": "ACTIVE" }, "parcels": [ { "type": "RETURN", "status": "WAITING" } ] } ] }}Validation or business rule error
Missing, invalid, or revoked API key
Example
UnauthorizedThe API key has READ scope; this operation needs WRITE
object
Example
{ "error": "INSUFFICIENT_SCOPE"}Not found
object
Example
{ "error": "COMPANY_NOT_FOUND"}Rate limit exceeded. The RateLimit-* headers give the limit and the reset time.
Example
Too many requests, please try again later.DEVICE_PROVISIONING_FAILED: the devices were created but MDM provisioning failed. List devices before retrying, or the retry creates duplicates. PLATFORM_DEVICE_ACTOR_NOT_FOUND: the company has no admin to record as the author.
object
Example
{ "error": "INTERNAL_ERROR"}Rate limiting is temporarily unavailable; retry with backoff
object
Example generated
{ "message": "example"}
