Deel: Create an IT order
Deel itOrders.createItOrder: arguments, response, policy and SDK examples.
← IT orders operations · Get started
Operation deel.itorders_createitorder_v2026_09_17
Provider route: POST /it/orders. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["itOrders"]["createItOrder"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.itOrders.createItOrder(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.it_orders.create_it_order(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create an IT order — request body — body data |
Referenced models: Create an IT order — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Cancel an IT order — 200 response body |
Referenced models: Cancel an IT order — 200 response body
Schemas
Section titled “Schemas”9 more schemas are linked from the tables above, on the schema pages.
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
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
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 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
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
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 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
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 — 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
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.itorders_createitorder_v2026_09_17. Catalog operation: itorders_createitorder_v2026_09_17. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["it-orders:write"]
Pinned headers: {"X-Version": "2026-09-17"}