Deel: Retrieve an IT order
Deel itOrders.retrieveAnItOrder: arguments, response, policy and SDK examples.
← IT orders operations · Get started
Operation deel.itorders_retrieveanitorder_v2026_01_01
Provider route: GET /it/orders/{order_id}. 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"]["retrieveAnItOrder"]>[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.retrieveAnItOrder(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.retrieve_an_it_order(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.order_id | string | Required within parent | Format: uuid |
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 Retrieve an IT order — 200 response body |
Referenced models: Retrieve an IT order — 200 response body
Schemas
Section titled “Schemas”7 more schemas are linked from the tables above, on the schema pages.
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 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
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
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
List IT assets — 200 response body — data item product
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Product details |
brand | string | Required within parent | Product brand |
category | Model | Required within parent | Expand Retrieve a product's catalog details — 200 response body — data category Product category |
id | string | Required within parent | Unique identifier of the product Format: uuid |
name | string | Required within parent | Product name |
Referenced models: Retrieve a product's catalog details — 200 response body — data category
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.itorders_retrieveanitorder_v2026_01_01. Catalog operation: itorders_retrieveanitorder_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"}