Create external devices (batch)

POST

/devices

Authorizations

• bearerAuth

Request Body

object

devices

required

Array<object>

>= 1 items

object

name

required

string

>= 1 characters

type

required

string

>= 1 characters

category

required

string

>= 1 characters

user_id

integer

added_via

Onboarding channel for the device.

string

Allowed values: MASS_IMPORT SINGLE_IMPORT ONBOARDING

Example

SINGLE_IMPORT

is_rented

boolean

brand

string

>= 1 characters

serial_number

string

>= 1 characters

client_purchase_price

string

>= 1 characters

client_purchase_date

string

>= 1 characters

client_warranty_endDate

string

>= 1 characters

client_rental_price

string

>= 1 characters

client_rental_startDate

string

>= 1 characters

client_rental_endDate

string

>= 1 characters

client_contract_number

string

>= 1 characters

client_invoice_number

string

>= 1 characters

screen_size

string

>= 1 characters

graphic

string

>= 1 characters

processor

string

>= 1 characters

ram

string

>= 1 characters

storage

string

>= 1 characters

model_year

string

>= 1 characters

connectivity

string

>= 1 characters

resolution

string

>= 1 characters

comment

string

>= 1 characters

color

string

>= 1 characters

seats_number

string

>= 1 characters

assembly

string

>= 1 characters

os_platform

string

>= 1 characters

keyboard_layout

Keyboard layout key (same enum as cart/order keyboard_layout).

string

Allowed values: FRENCH_AZERTY SPANISH_QWERTY ITALIAN_QWERTY INTERNATIONAL_ENGLISH_QWERTY GERMAN_QWERTZ PORTUGUESE_QWERTY ENGLISH_QWERTY SWISS_QWERTZ AMERICAN_ENGLISH_QWERTY CANADIAN_ENGLISH_QWERTY DUTCH_QWERTY

Example

FRENCH_AZERTY

has_microphone

boolean

nullable

has_webcam

boolean

nullable

noise_cancellation

boolean

nullable

compliance

Any of:

Array<string>

Array<string>

string

string

>= 1 characters

unknown

nullable

connection_type

Connection type labels; accepts a single string or an array of strings.

Array<string>

nullable

has_stool

boolean

nullable

has_video_package

boolean

nullable

has_screen

boolean

nullable

has_premium_tablet

boolean

nullable

Responses

201

Devices created

object

data

required

object

devices

required

Array<object>

object

id

required

integer

name

required

string

nullable

serial_number

required

string

nullable

rent

required

string

nullable

tracking_number

required

string

nullable

tracking_url

required

Tracking page URL.

string

nullable

client_status

required

Device progress key for display and filtering

string

Allowed values: ARCHIVED PENDING_VALIDATION IN_PREPARATION DELIVERED SHIPPED AVAILABLE IN_SERVICE IN_MAINTENANCE OUT_OF_SERVICE

type

required

string

nullable

category

required

string

nullable

source

required

string

nullable

comment

required

Free-form device comment

string

nullable

characteristics

required

object

screen_size

required

string

nullable

graphic

required

string

nullable

processor

required

string

nullable

ram

required

string

nullable

storage

required

string

nullable

model_year

required

string

nullable

connectivity

required

string

nullable

keyboard_layout

required

Keyboard layout code used for pricing and device configuration.

string

nullable

Allowed values: FRENCH_AZERTY SPANISH_QWERTY ITALIAN_QWERTY INTERNATIONAL_ENGLISH_QWERTY GERMAN_QWERTZ PORTUGUESE_QWERTY ENGLISH_QWERTY SWISS_QWERTZ AMERICAN_ENGLISH_QWERTY CANADIAN_ENGLISH_QWERTY DUTCH_QWERTY

Example

FRENCH_AZERTY

resolution

required

string

nullable

has_microphone

required

boolean

nullable

has_webcam

required

boolean

nullable

noise_cancellation

required

boolean

nullable

compliance

required

Array<string>

nullable

connection_type

required

Array<string>

nullable

has_stool

required

boolean

nullable

has_video_package

required

boolean

nullable

has_screen

required

boolean

nullable

has_premium_tablet

required

boolean

nullable

color

required

string

nullable

seats_number

required

string

nullable

assembly

required

string

nullable

os_platform

required

string

nullable

mdm

required

MDM enrollment details when the device is enrolled; null otherwise

object

id

required

integer

status

required

MDM enrollment status.

string

Allowed values: SUBSCRIBED DOWNLOADED IDENTIFIED ENROLLMENT_IN_PROGRESS ENROLLED UNENROLLED DEVICE_WIPE_PENDING

local_name

required

string

nullable

is_locked

required

boolean

nullable

lock_date

required

string

nullable

firewall_enabled

required

boolean

nullable

os_updates_enabled

required

boolean

nullable

is_encrypted

required

boolean

nullable

screenlock_enabled

required

boolean

nullable

is_compromised

required

boolean

nullable

os_updates_available

required

boolean

nullable

disk_encryption_profile_installed

required

boolean

nullable

enrollment_date

required

string

nullable

unenrollment_date

required

string

nullable

download_date

required

string

nullable

last_seen_date

required

string

nullable

last_sync_date

required

string

nullable

order

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

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

parcels

required

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.

Array<object>

object

id

required

integer

type

required

RETURN: device return shipment. INTER_OFFICE_DELIVERY: inter-office move.

string

Allowed values: RETURN INTER_OFFICE_DELIVERY

status

required

Parcel shipment progress.

string

Allowed values: WAITING SCHEDULED SHIPPED RECEIVED FAILED

tracking_number

required

string

nullable

tracking_url

required

Tracking page URL.

string

nullable

carrier

required

string

nullable

pickup_address_id

required

integer

nullable

reception_address_id

required

integer

nullable

pickup_date

required

string

nullable

reception_date

required

string

nullable

shipping_date

required

string

nullable

created_at

required

string

nullable

400

Validation or business rule error

Any of:

object

object

error

required

string

object

object

error

required

string

Allowed values: INVALID_SERIAL_NUMBER INVALID_USER KEYBOARD_LAYOUT_REQUIRED

403

Forbidden

object

error

required

string

Allowed values: INSUFFICIENT_SCOPE

404

Not found

object

error

required

string

Allowed values: COMPANY_NOT_FOUND

500

Internal error

object

error

required

string

Allowed values: INTERNAL_ERROR