Deel: IT orders schemas
23 Deel schemas with complete fields and constraints.
← IT orders operations · All schemas
Cancel an IT order — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Creation timestamp of the order Format: date-time |
delivery_address | Model | Required within parent | Expand Cancel an IT order — 200 response body — data delivery address Delivery address of the order |
id | string | Required within parent | Unique identifier of the order Format: uuid |
order_items | array | Required within parent | Order's items details |
order_items[] | Model | Each item | Expand Cancel an IT order — 200 response body — data order items item |
public_id | string | Required within parent | Public identifier of the order |
status | string | Required within parent | Order status Known values: APPROVED, CANCELLED, DECLINED, REQUESTED |
updated_at | string | Required within parent | Last update timestamp of the order Format: date-time |
user | JSON | Required within parent | Details of the user the order is for |
user (anyOf 1) | Model | Alternative | Expand Cancel an IT order — 200 response body — data user Details of the user the order is for |
user (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Delivery address of the order |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | City name |
city (anyOf 2) | null | Alternative | City name |
country | Model | Required within parent | Expand Cancel an IT order — 200 response body — data delivery address country Country code |
date_of_birth | JSON | Required within parent | |
date_of_birth (anyOf 1) | string | Alternative | Date of birth (applicable for some address types) Format: date |
date_of_birth (anyOf 2) | null | Alternative | Date of birth (applicable for some address types) Format: date |
delivery_instructions | JSON | Required within parent | |
delivery_instructions (anyOf 1) | string | Alternative | Special instructions for deliveries |
delivery_instructions (anyOf 2) | null | Alternative | Special instructions for deliveries |
id | string | Required within parent | Unique identifier of the address Format: uuid |
is_valid | boolean | Required within parent | Whether the address passes validation |
line1 | JSON | Required within parent | |
line1 (anyOf 1) | string | Alternative | Address line 1 |
line1 (anyOf 2) | null | Alternative | Address line 1 |
line2 | JSON | Required within parent | |
line2 (anyOf 1) | string | Alternative | Address line 2 |
line2 (anyOf 2) | null | Alternative | Address line 2 |
passport_number | JSON | Required within parent | |
passport_number (anyOf 1) | string | Alternative | Passport number (applicable for some address types) |
passport_number (anyOf 2) | null | Alternative | Passport number (applicable for some address types) |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | Phone number |
phone_number (anyOf 2) | null | Alternative | Phone number |
post_code | JSON | Required within parent | |
post_code (anyOf 1) | string | Alternative | Post code |
post_code (anyOf 2) | null | Alternative | Post code |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | State code or name |
state (anyOf 2) | null | Alternative | State code or name |
tax_id_number | JSON | Required within parent | |
tax_id_number (anyOf 1) | string | Alternative | Tax ID number (applicable for some address types) |
tax_id_number (anyOf 2) | null | Alternative | Tax ID number (applicable for some address types) |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Country 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Creation timestamp of the order item Format: date-time |
id | string | Required within parent | Unique identifier of the order item Format: uuid |
is_approved | boolean | Required within parent | Is the order item approved |
is_express_delivery_requested | boolean | Required within parent | Is express delivery requested for the order item |
pricing_details | Model | Required within parent | Expand Cancel an IT order — 200 response body — data order items item pricing details Order item pricing details |
product | Model | Required within parent | Expand List IT assets — 200 response body — data item product Product details |
status | string | Required within parent | Status 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Order item pricing details |
acquisition_type | string | Required within parent | Acquisition type of the order item Known values: PURCHASE, RENTAL, REUSE |
asset_price | JSON | Required within parent | Price of the order item |
asset_price (anyOf 1) | Model | Alternative | Expand Cancel an IT order — 200 response body — data order items item pricing details asset price Price of the order item |
asset_price (anyOf 2) | null | Alternative | |
storefront_fee | JSON | Required within parent | Storefront fee associated with the order item |
storefront_fee (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Price of the order item |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Storefront fee associated with the order item |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the user the order is for |
emails | array | Required within parent | Array of user email addresses |
emails[] | string | Each item | Format: email |
first_name | string | Required within parent | First name of the user |
hris_profile_id | string | Required within parent | The unique identifier of the HRIS profile of the assigned user Format: uuid |
last_name | string | Required within parent | Last name of the user |
Cancel an IT order — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cancelled_reason | string | Required within parent | Reason the order was cancelled One of: ADDRESS_ISSUE, DELAY_WANTED, DUPLICATE, ITEM_CHANGE, NOT_NEEDED, OTHER, PRICE, WRONG_WORKER |
cancelled_reason_description | string | Optional | Free-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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
destination | Model | Required within parent | Expand Create an IT order — request body — body data destination Where the order goes |
is_express_delivery_requested | boolean | Required within parent | Whether express delivery was requested for this order |
variants | array | Required within parent | One entry per item to order |
variants[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Where the order goes |
assign_to | string | Required within parent | Who the ordered items are assigned to One of: USER |
delivery_address | Model | Required within parent | Expand Create an IT order — request body — body data destination delivery address Delivery address for the order |
hris_profile_id | string | Required within parent | HRIS 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Delivery address for the order |
city | string | Optional | City name |
country | Model | Required within parent | Expand Assign asset to new holder — request body — body data delivery address country Country code (ISO 3166 alpha-2) |
date_of_birth | string | Optional | Date of birth Format: date |
delivery_instructions | string | Optional | Delivery instructions for the courier |
line1 | string | Optional | Address line 1 |
line2 | string | Optional | Address line 2 |
passport_number | string | Optional | Passport number |
phone_number | string | Optional | Phone number in E.164 format |
post_code | string | Optional | Post code |
state | string | Optional | State or region name |
tax_id_number | string | Optional | Tax 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_setting | Model | Required within parent | Expand Create an IT order — request body — body data variants item contract setting Contract terms — acquisition type, rental term, payment schema, and addons |
is_preconfig_requested | boolean | Optional | Whether preconfiguration was requested for the delivered device |
variant_id | string | Required within parent | Variant 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract terms — acquisition type, rental term, payment schema, and addons |
acquisition_type | string | Required within parent | How the equipment is acquired One of: PURCHASE, RENTAL, REUSE |
addons | array | Required within parent | Addon 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[] | Model | Each item | Expand Create an IT order — request body — body data variants item contract setting addons item |
payment_schema | string | Optional | How the equipment is billed. Required for rentals, ignored for purchases (always upfront). One of: MONTHLY, UPFRONT |
rental_term | string | Optional | Rental 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bundle | string | Required within parent | Which 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_months | integer | Optional | Bundle duration in months. Service bundles only; nil for warranties and one-off addons. Format: int64 |
payment_schema | string | Optional | How the addon is billed. Omit to accept the default schema for the bundle. One of: MONTHLY, UPFRONT |
List IT orders — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List IT orders — 200 response body — data item |
has_more | boolean | Required within parent | Whether there are more results available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to the next page |
next_cursor (anyOf 2) | null | Alternative | Cursor to the next page |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of records Format: int64 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Creation timestamp of the order Format: date-time |
id | string | Required within parent | Unique identifier of the order Format: uuid |
order_items | array | Required within parent | Order's items details |
order_items[] | Model | Each item | Expand Cancel an IT order — 200 response body — data order items item |
public_id | string | Required within parent | Public identifier of the order |
status | string | Required within parent | Order status Known values: APPROVED, CANCELLED, DECLINED, REQUESTED |
updated_at | string | Required within parent | Last update timestamp of the order Format: date-time |
user | JSON | Required within parent | Details of the user with asset possession |
user (anyOf 1) | Model | Alternative | Expand Retrieve an IT order — 200 response body — data user Details of the user with asset possession |
user (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Creation timestamp of the order Format: date-time |
delivery_address | Model | Required within parent | Expand Retrieve an IT order — 200 response body — data delivery address Order delivery address details |
delivery_estimate | JSON | Required within parent | Estimated 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) | Model | Alternative | Expand Retrieve an IT order — 200 response body — data delivery estimate from, to |
delivery_estimate (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the order Format: uuid |
order_items | array | Required within parent | Order's items details |
order_items[] | Model | Each item | Expand Cancel an IT order — 200 response body — data order items item |
public_id | string | Required within parent | Public identifier of the order |
status | string | Required within parent | Order status Known values: APPROVED, CANCELLED, DECLINED, REQUESTED |
updated_at | string | Required within parent | Last update timestamp of the order Format: date-time |
user | JSON | Required within parent | Details of the user with asset possession |
user (anyOf 1) | Model | Alternative | Expand Retrieve an IT order — 200 response body — data user Details of the user with asset possession |
user (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Order delivery address details |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | City name |
city (anyOf 2) | null | Alternative | City name |
country | Model | Required within parent | Expand Cancel an IT order — 200 response body — data delivery address country Country code |
date_of_birth | JSON | Required within parent | |
date_of_birth (anyOf 1) | string | Alternative | Date of birth (applicable for some address types) Format: date |
date_of_birth (anyOf 2) | null | Alternative | Date of birth (applicable for some address types) Format: date |
delivery_instructions | JSON | Required within parent | |
delivery_instructions (anyOf 1) | string | Alternative | Special instructions for deliveries |
delivery_instructions (anyOf 2) | null | Alternative | Special instructions for deliveries |
id | string | Required within parent | Unique identifier of the address Format: uuid |
is_valid | boolean | Required within parent | Whether the address passes validation |
line1 | JSON | Required within parent | |
line1 (anyOf 1) | string | Alternative | Address line 1 |
line1 (anyOf 2) | null | Alternative | Address line 1 |
line2 | JSON | Required within parent | |
line2 (anyOf 1) | string | Alternative | Address line 2 |
line2 (anyOf 2) | null | Alternative | Address line 2 |
passport_number | JSON | Required within parent | |
passport_number (anyOf 1) | string | Alternative | Passport number (applicable for some address types) |
passport_number (anyOf 2) | null | Alternative | Passport number (applicable for some address types) |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | Phone number |
phone_number (anyOf 2) | null | Alternative | Phone number |
post_code | JSON | Required within parent | |
post_code (anyOf 1) | string | Alternative | Post code |
post_code (anyOf 2) | null | Alternative | Post code |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | State code or name |
state (anyOf 2) | null | Alternative | State code or name |
tax_id_number | JSON | Required within parent | |
tax_id_number (anyOf 1) | string | Alternative | Tax ID number (applicable for some address types) |
tax_id_number (anyOf 2) | null | Alternative | Tax ID number (applicable for some address types) |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Estimated 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. |
from | string | Required within parent | Earliest estimated delivery date Format: date |
to | string | Required within parent | Latest estimated delivery date Format: date |
Retrieve an IT order — 200 response body — data user Details of the user with asset possession
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the user with asset possession |
address | Model | Required within parent | Expand 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 |
emails | array | Required within parent | Array of user email addresses |
emails[] | string | Each item | Format: email |
first_name | string | Required within parent | First name of the user |
hris_profile_id | string | Required within parent | The unique identifier of the HRIS profile of the assigned user Format: uuid |
last_name | string | Required within parent | Last 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