Skip to content

Deel: Cancel an IT order

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

← IT orders operations · Get started

Operation deel.itorders_cancelitorder_v2026_09_15

Provider route: POST /it/orders/{order_id}/cancel. 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"]["cancelItOrder"]>[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.cancelItOrder(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.cancel_it_order(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.order_idstringRequired within parentFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true
bodyobjectOptional
body.dataModelRequired within parentExpand Cancel an IT order — request body — body data

Referenced models: Cancel 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

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

Cancel an IT order — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
cancelled_reasonstringRequired within parentReason the order was cancelled
One of: ADDRESS_ISSUE, DELAY_WANTED, DUPLICATE, ITEM_CHANGE, NOT_NEEDED, OTHER, PRICE, WRONG_WORKER
cancelled_reason_descriptionstringOptionalFree-text description explaining the cancellation. Required when cancelled_reason is OTHER; max 500 characters.
Maximum length: 500
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

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

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

Cancel an IT order — 200 response body — data delivery address
FieldTypePresenceDescription and constraints
$objectRootDelivery address of the order
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 order items item pricing details
FieldTypePresenceDescription and constraints
$objectRootOrder item pricing details
acquisition_typestringRequired within parentAcquisition type of the order item
Known values: PURCHASE, RENTAL, REUSE
asset_priceJSONRequired within parentPrice of the order item
asset_price (anyOf 1)ModelAlternativeExpand Cancel an IT order — 200 response body — data order items item pricing details asset price Price of the order item
asset_price (anyOf 2)nullAlternative
storefront_feeJSONRequired within parentStorefront fee associated with the order item
storefront_fee (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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

SDK function policy ID: deel.itorders_cancelitorder_v2026_09_15. Catalog operation: itorders_cancelitorder_v2026_09_15. 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-15"}

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.