Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true
bodyobjectOptional
body.dataModelRequired within parentExpand Create an IT order — request body — body data

Referenced models: Create an IT order — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Cancel an IT order — 200 response body

Referenced models: Cancel an IT order — 200 response body

9 more schemas are linked from the tables above, on the schema pages.

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

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

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 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

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

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 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

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 — 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

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

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"}

Official provider source

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.