Skip to content

Deel: List IT orders

Deel itOrders.listItOrders: arguments, response, policy and SDK examples.

← IT orders operations · Get started

Operation deel.itorders_listitorders_v2026_01_01

Provider route: GET /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"]["listItOrders"]>[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.listItOrders(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.list_it_orders(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List IT orders — 200 response body

Referenced models: List IT orders — 200 response body

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

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

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

List users assigned to an IT policy — it Policies list It Policy Users Variant Itpolicies Listitpolicyusers V20260917 — 200 response body — data item address
FieldTypePresenceDescription and constraints
$objectRootUser 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

List IT assets — 200 response body — data item product
FieldTypePresenceDescription and constraints
$objectRootProduct details
brandstringRequired within parentProduct brand
categoryModelRequired within parentExpand Retrieve a product's catalog details — 200 response body — data category
Product category
idstringRequired within parentUnique identifier of the product
Format: uuid
namestringRequired within parentProduct name

Referenced models: Retrieve a product's catalog details — 200 response body — data category

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

SDK function policy ID: deel.itorders_listitorders_v2026_01_01. Catalog operation: itorders_listitorders_v2026_01_01. 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:read"]

Pinned headers: {"X-Version": "2026-01-01"}

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.