Skip to content

Deel: IT orders schemas

23 Deel schemas with complete fields and constraints.

← IT orders operations · All schemas

Cancel an IT order — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Cancel an IT order — 200 response body — data

Referenced models: Cancel an IT order — 200 response body — data

Cancel an IT order — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentCreation timestamp of the order
Format: date-time
delivery_addressModelRequired within parentExpand Cancel an IT order — 200 response body — data delivery address
Delivery address of the order
idstringRequired within parentUnique identifier of the order
Format: uuid
order_itemsarrayRequired within parentOrder's items details
order_items[]ModelEach itemExpand Cancel an IT order — 200 response body — data order items item
public_idstringRequired within parentPublic identifier of the order
statusstringRequired within parentOrder status
Known values: APPROVED, CANCELLED, DECLINED, REQUESTED
updated_atstringRequired within parentLast update timestamp of the order
Format: date-time
userJSONRequired within parentDetails of the user the order is for
user (anyOf 1)ModelAlternativeExpand Cancel an IT order — 200 response body — data user Details of the user the order is for
user (anyOf 2)nullAlternative

Referenced models: Cancel an IT order — 200 response body — data user Details of the user the order is for, Cancel an IT order — 200 response body — data order items item, Cancel an IT order — 200 response body — data delivery address

Cancel an IT order — 200 response body — data delivery address

FieldTypePresenceDescription and constraints
$objectRootDelivery address of the order
cityJSONRequired within parent
city (anyOf 1)stringAlternativeCity name
city (anyOf 2)nullAlternativeCity name
countryModelRequired within parentExpand Cancel an IT order — 200 response body — data delivery address country
Country code
date_of_birthJSONRequired within parent
date_of_birth (anyOf 1)stringAlternativeDate of birth (applicable for some address types)
Format: date
date_of_birth (anyOf 2)nullAlternativeDate of birth (applicable for some address types)
Format: date
delivery_instructionsJSONRequired within parent
delivery_instructions (anyOf 1)stringAlternativeSpecial instructions for deliveries
delivery_instructions (anyOf 2)nullAlternativeSpecial instructions for deliveries
idstringRequired within parentUnique identifier of the address
Format: uuid
is_validbooleanRequired within parentWhether the address passes validation
line1JSONRequired within parent
line1 (anyOf 1)stringAlternativeAddress line 1
line1 (anyOf 2)nullAlternativeAddress line 1
line2JSONRequired within parent
line2 (anyOf 1)stringAlternativeAddress line 2
line2 (anyOf 2)nullAlternativeAddress line 2
passport_numberJSONRequired within parent
passport_number (anyOf 1)stringAlternativePassport number (applicable for some address types)
passport_number (anyOf 2)nullAlternativePassport number (applicable for some address types)
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternativePhone number
phone_number (anyOf 2)nullAlternativePhone number
post_codeJSONRequired within parent
post_code (anyOf 1)stringAlternativePost code
post_code (anyOf 2)nullAlternativePost code
stateJSONRequired within parent
state (anyOf 1)stringAlternativeState code or name
state (anyOf 2)nullAlternativeState code or name
tax_id_numberJSONRequired within parent
tax_id_number (anyOf 1)stringAlternativeTax ID number (applicable for some address types)
tax_id_number (anyOf 2)nullAlternativeTax ID number (applicable for some address types)
typestringRequired within parentType of the address
Known values: BILLING, COLLECTION, DELIVERY, ENTITY, PARTIAL, PII, SUPPLIER

Referenced models: Cancel an IT order — 200 response body — data delivery address country

Cancel an IT order — 200 response body — data delivery address country

FieldTypePresenceDescription and constraints
$stringRootCountry code
Known values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW

Cancel an IT order — 200 response body — data order items item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentCreation timestamp of the order item
Format: date-time
idstringRequired within parentUnique identifier of the order item
Format: uuid
is_approvedbooleanRequired within parentIs the order item approved
is_express_delivery_requestedbooleanRequired within parentIs express delivery requested for the order item
pricing_detailsModelRequired within parentExpand Cancel an IT order — 200 response body — data order items item pricing details
Order item pricing details
productModelRequired within parentExpand List IT assets — 200 response body — data item product
Product details
statusstringRequired within parentStatus of the order item
Known values: AWAITING_PAYMENT, CANCELLED, COMPLETED, PLACED, PROCESSING, READY_TO_SHIP, SHIPPED

Referenced models: List IT assets — 200 response body — data item product, Cancel an IT order — 200 response body — data order items item pricing details

Cancel an IT order — 200 response body — data order items item pricing details

FieldTypePresenceDescription and constraints
$objectRootOrder item pricing details
acquisition_typestringRequired within parentAcquisition type of the order item
Known values: PURCHASE, RENTAL, REUSE
asset_priceJSONRequired within parentPrice of the order item
asset_price (anyOf 1)ModelAlternativeExpand Cancel an IT order — 200 response body — data order items item pricing details asset price Price of the order item
asset_price (anyOf 2)nullAlternative
storefront_feeJSONRequired within parentStorefront fee associated with the order item
storefront_fee (anyOf 1)ModelAlternativeExpand Cancel an IT order — 200 response body — data order items item pricing details storefront fee Storefront fee associated with the order item
storefront_fee (anyOf 2)nullAlternative

Referenced models: Cancel an IT order — 200 response body — data order items item pricing details asset price Price of the order item, Cancel an IT order — 200 response body — data order items item pricing details storefront fee Storefront fee associated with the order item

Cancel an IT order — 200 response body — data order items item pricing details asset price Price of the order item

FieldTypePresenceDescription and constraints
$objectRootPrice of the order item
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Cancel an IT order — 200 response body — data order items item pricing details storefront fee Storefront fee associated with the order item

FieldTypePresenceDescription and constraints
$objectRootStorefront fee associated with the order item
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Cancel an IT order — 200 response body — data user Details of the user the order is for

FieldTypePresenceDescription and constraints
$objectRootDetails of the user the order is for
emailsarrayRequired within parentArray of user email addresses
emails[]stringEach itemFormat: email
first_namestringRequired within parentFirst name of the user
hris_profile_idstringRequired within parentThe unique identifier of the HRIS profile of the assigned user
Format: uuid
last_namestringRequired within parentLast name of the user

Cancel an IT order — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
cancelled_reasonstringRequired within parentReason the order was cancelled
One of: ADDRESS_ISSUE, DELAY_WANTED, DUPLICATE, ITEM_CHANGE, NOT_NEEDED, OTHER, PRICE, WRONG_WORKER
cancelled_reason_descriptionstringOptionalFree-text description explaining the cancellation. Required when cancelled_reason is OTHER; max 500 characters.
Maximum length: 500

Create an IT order — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
destinationModelRequired within parentExpand Create an IT order — request body — body data destination
Where the order goes
is_express_delivery_requestedbooleanRequired within parentWhether express delivery was requested for this order
variantsarrayRequired within parentOne entry per item to order
variants[]ModelEach itemExpand Create an IT order — request body — body data variants item

Referenced models: Create an IT order — request body — body data destination, Create an IT order — request body — body data variants item

Create an IT order — request body — body data destination

FieldTypePresenceDescription and constraints
$objectRootWhere the order goes
assign_tostringRequired within parentWho the ordered items are assigned to
One of: USER
delivery_addressModelRequired within parentExpand Create an IT order — request body — body data destination delivery address
Delivery address for the order
hris_profile_idstringRequired within parentHRIS profile that will receive the order
Format: uuid

Referenced models: Create an IT order — request body — body data destination delivery address

Create an IT order — request body — body data destination delivery address

FieldTypePresenceDescription and constraints
$objectRootDelivery address for the order
citystringOptionalCity name
countryModelRequired within parentExpand Assign asset to new holder — request body — body data delivery address country
Country code (ISO 3166 alpha-2)
date_of_birthstringOptionalDate of birth
Format: date
delivery_instructionsstringOptionalDelivery instructions for the courier
line1stringOptionalAddress line 1
line2stringOptionalAddress line 2
passport_numberstringOptionalPassport number
phone_numberstringOptionalPhone number in E.164 format
post_codestringOptionalPost code
statestringOptionalState or region name
tax_id_numberstringOptionalTax ID number

Referenced models: Assign asset to new holder — request body — body data delivery address country

Create an IT order — request body — body data variants item

FieldTypePresenceDescription and constraints
$objectRoot
contract_settingModelRequired within parentExpand Create an IT order — request body — body data variants item contract setting
Contract terms — acquisition type, rental term, payment schema, and addons
is_preconfig_requestedbooleanOptionalWhether preconfiguration was requested for the delivered device
variant_idstringRequired within parentVariant of the product to order
Format: uuid

Referenced models: Create an IT order — request body — body data variants item contract setting

Create an IT order — request body — body data variants item contract setting

FieldTypePresenceDescription and constraints
$objectRootContract terms — acquisition type, rental term, payment schema, and addons
acquisition_typestringRequired within parentHow the equipment is acquired
One of: PURCHASE, RENTAL, REUSE
addonsarrayRequired within parentAddon bundles attached to this contract. At most one service and one warranty; a device takes both or neither, and an accessory takes none (empty array). Server derives the type from each `bundle`.
addons[]ModelEach itemExpand Create an IT order — request body — body data variants item contract setting addons item
payment_schemastringOptionalHow the equipment is billed. Required for rentals, ignored for purchases (always upfront).
One of: MONTHLY, UPFRONT
rental_termstringOptionalRental term length. Required for rentals, ignored otherwise.
One of: MONTH_12, MONTH_24

Referenced models: Create an IT order — request body — body data variants item contract setting addons item

Create an IT order — request body — body data variants item contract setting addons item

FieldTypePresenceDescription and constraints
$objectRoot
bundlestringRequired within parentWhich addon to add. Pick it from `bundle` in `available_addons[]` on `GET /products/{id}/prices`; the server derives whether it is a service or a warranty.
One of: DLM, DLM_PLUS, GLOBAL_WARRANTY, STANDARD_AND_LOANER, STANDARD_SERVICE, STANDARD_WARRANTY
duration_monthsintegerOptionalBundle duration in months. Service bundles only; nil for warranties and one-off addons.
Format: int64
payment_schemastringOptionalHow the addon is billed. Omit to accept the default schema for the bundle.
One of: MONTHLY, UPFRONT

List IT orders — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List IT orders — 200 response body — data item
has_morebooleanRequired within parentWhether there are more results available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to the next page
next_cursor (anyOf 2)nullAlternativeCursor to the next page
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of records
Format: int64
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List IT orders — 200 response body — data item

List IT orders — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentCreation timestamp of the order
Format: date-time
idstringRequired within parentUnique identifier of the order
Format: uuid
order_itemsarrayRequired within parentOrder's items details
order_items[]ModelEach itemExpand Cancel an IT order — 200 response body — data order items item
public_idstringRequired within parentPublic identifier of the order
statusstringRequired within parentOrder status
Known values: APPROVED, CANCELLED, DECLINED, REQUESTED
updated_atstringRequired within parentLast update timestamp of the order
Format: date-time
userJSONRequired within parentDetails of the user with asset possession
user (anyOf 1)ModelAlternativeExpand Retrieve an IT order — 200 response body — data user Details of the user with asset possession
user (anyOf 2)nullAlternative

Referenced models: Retrieve an IT order — 200 response body — data user Details of the user with asset possession, Cancel an IT order — 200 response body — data order items item

Retrieve an IT order — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve an IT order — 200 response body — data

Referenced models: Retrieve an IT order — 200 response body — data

Retrieve an IT order — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentCreation timestamp of the order
Format: date-time
delivery_addressModelRequired within parentExpand Retrieve an IT order — 200 response body — data delivery address
Order delivery address details
delivery_estimateJSONRequired within parentEstimated delivery range of the items still to be delivered, replaced by the courier's estimate
once shipped. A range that spans a weekend has from equal to to (arrives by that date). Null when
nothing on the order is left to deliver.
delivery_estimate (anyOf 1)ModelAlternativeExpand Retrieve an IT order — 200 response body — data delivery estimate from, to
delivery_estimate (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the order
Format: uuid
order_itemsarrayRequired within parentOrder's items details
order_items[]ModelEach itemExpand Cancel an IT order — 200 response body — data order items item
public_idstringRequired within parentPublic identifier of the order
statusstringRequired within parentOrder status
Known values: APPROVED, CANCELLED, DECLINED, REQUESTED
updated_atstringRequired within parentLast update timestamp of the order
Format: date-time
userJSONRequired within parentDetails of the user with asset possession
user (anyOf 1)ModelAlternativeExpand Retrieve an IT order — 200 response body — data user Details of the user with asset possession
user (anyOf 2)nullAlternative

Referenced models: Retrieve an IT order — 200 response body — data delivery estimate from, to, Retrieve an IT order — 200 response body — data user Details of the user with asset possession, Cancel an IT order — 200 response body — data order items item, Retrieve an IT order — 200 response body — data delivery address

Retrieve an IT order — 200 response body — data delivery address

FieldTypePresenceDescription and constraints
$objectRootOrder delivery address details
cityJSONRequired within parent
city (anyOf 1)stringAlternativeCity name
city (anyOf 2)nullAlternativeCity name
countryModelRequired within parentExpand Cancel an IT order — 200 response body — data delivery address country
Country code
date_of_birthJSONRequired within parent
date_of_birth (anyOf 1)stringAlternativeDate of birth (applicable for some address types)
Format: date
date_of_birth (anyOf 2)nullAlternativeDate of birth (applicable for some address types)
Format: date
delivery_instructionsJSONRequired within parent
delivery_instructions (anyOf 1)stringAlternativeSpecial instructions for deliveries
delivery_instructions (anyOf 2)nullAlternativeSpecial instructions for deliveries
idstringRequired within parentUnique identifier of the address
Format: uuid
is_validbooleanRequired within parentWhether the address passes validation
line1JSONRequired within parent
line1 (anyOf 1)stringAlternativeAddress line 1
line1 (anyOf 2)nullAlternativeAddress line 1
line2JSONRequired within parent
line2 (anyOf 1)stringAlternativeAddress line 2
line2 (anyOf 2)nullAlternativeAddress line 2
passport_numberJSONRequired within parent
passport_number (anyOf 1)stringAlternativePassport number (applicable for some address types)
passport_number (anyOf 2)nullAlternativePassport number (applicable for some address types)
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternativePhone number
phone_number (anyOf 2)nullAlternativePhone number
post_codeJSONRequired within parent
post_code (anyOf 1)stringAlternativePost code
post_code (anyOf 2)nullAlternativePost code
stateJSONRequired within parent
state (anyOf 1)stringAlternativeState code or name
state (anyOf 2)nullAlternativeState code or name
tax_id_numberJSONRequired within parent
tax_id_number (anyOf 1)stringAlternativeTax ID number (applicable for some address types)
tax_id_number (anyOf 2)nullAlternativeTax ID number (applicable for some address types)
typestringRequired within parentType of the address
Known values: BILLING, COLLECTION, DELIVERY, ENTITY, PARTIAL, PII, SUPPLIER

Referenced models: Cancel an IT order — 200 response body — data delivery address country

Retrieve an IT order — 200 response body — data delivery estimate from, to

FieldTypePresenceDescription and constraints
$objectRootEstimated delivery range of the items still to be delivered, replaced by the courier's estimate
once shipped. A range that spans a weekend has from equal to to (arrives by that date). Null when
nothing on the order is left to deliver.
fromstringRequired within parentEarliest estimated delivery date
Format: date
tostringRequired within parentLatest estimated delivery date
Format: date

Retrieve an IT order — 200 response body — data user Details of the user with asset possession

FieldTypePresenceDescription and constraints
$objectRootDetails of the user with asset possession
addressModelRequired within parentExpand List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body — data item address
User address details
emailsarrayRequired within parentArray of user email addresses
emails[]stringEach itemFormat: email
first_namestringRequired within parentFirst name of the user
hris_profile_idstringRequired within parentThe unique identifier of the HRIS profile of the assigned user
Format: uuid
last_namestringRequired within parentLast name of the user

Referenced models: List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body — data item address

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.