Deel: Create a collection for an IT asset
Deel itAssets.collectItAsset: arguments, response, policy and SDK examples.
← IT assets operations · Get started
Operation deel.itassets_collectitasset_v2026_09_15
Provider route: POST /it/assets/{asset_id}/collect. 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["itAssets"]["collectItAsset"]>[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.itAssets.collectItAsset(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_assets.collect_it_asset(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.asset_id | string | Required within parent | Format: uuid |
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 a collection for an IT asset — request body — body data |
Referenced models: Create a collection for an IT asset — 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 Update asset — 200 response body |
Referenced models: Update asset — 200 response body
Schemas
Section titled “Schemas”72 more schemas are linked from the tables above, on the schema pages.
Create a collection for an IT asset — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
collection_address | Model | Required within parent | Expand Create a collection for an IT asset — request body — body data collection address Location the asset is being collected from. |
not_before | string | Optional | Earliest date Deel logistics may execute the pickup. Format: date |
shipment_insurance | Model | Optional | Expand Assign asset to new holder — request body — body data shipment insurance Insurance-consent flag and optional purchase details Deel records against the asset. May be omitted (or sent with `is_waived: false` and no `purchase_details`) if the asset already has a purchase price and date on record. |
store_and_reuse_location | string | Optional | Deel-managed reuse destination for the collection. Mutually exclusive with `warehouse_id`. One of: DEEL_HUB, LOCAL_HUB |
warehouse_id | string | Optional | Destination warehouse identifier for the collection. Mutually exclusive with `store_and_reuse_location`. Format: uuid |
Referenced models: Create a collection for an IT asset — request body — body data collection address, Assign asset to new holder — request body — body data shipment insurance
Update asset — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update asset — 200 response body — data |
Referenced models: Update asset — 200 response body — data
Create a collection for an IT asset — request body — body data collection address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Location the asset is being collected from. |
country | Model | Optional | Expand Assign asset to new holder — request body — body data collection address country Country the asset is being picked up from. Overrides the country the asset-action validator derives from asset state. |
Referenced models: Assign asset to new holder — request body — body data collection address country
Assign asset to new holder — request body — body data shipment insurance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Insurance-consent flag and optional purchase details Deel records against the asset. May be omitted (or sent with `is_waived: false` and no `purchase_details`) if the asset already has a purchase price and date on record. |
is_waived | boolean | Required within parent | Consent to ship without insurance. When true, `purchase_details` must be omitted and Deel will not record a purchase price against the asset. |
purchase_details | Model | Optional | Expand Assign asset to new holder — request body — body data shipment insurance purchase details Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true. |
Referenced models: Assign asset to new holder — request body — body data shipment insurance purchase details
Update asset — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
actions | Model | Required within parent | Expand Update asset — 200 response body — data actions Actions the caller can execute on this asset, with availability status per action |
assigned_user | JSON | Required within parent | Details of the user with asset possession |
assigned_user (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data assigned user Details of the user with asset possession |
assigned_user (anyOf 2) | null | Alternative | |
assigned_warehouse | JSON | Required within parent | Details of the warehouse with asset possession |
assigned_warehouse (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION |
assigned_warehouse (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Creation timestamp of the asset Format: date-time |
grade | string | Required within parent | The condition grade of the asset Known values: A, B, C, D, F, NEW |
id | string | Required within parent | Unique identifier of the item Format: uuid |
keyboard_layout | JSON | Required within parent | Keyboard layout of the asset, null when none is recorded |
keyboard_layout (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data keyboard layout string |
keyboard_layout (anyOf 2) | null | Alternative | |
location | string | Required within parent | Current location type of the asset Known values: AT_WAREHOUSE, CLEARANCE_WAREHOUSE, DEEL_WAREHOUSE, ORGANIZATION_WAREHOUSE, SUPPLIER, WITH_COURIER, WITH_USER, WRITE_OFF |
operating_system | JSON | Required within parent | Operating system of the asset, null when none is recorded |
operating_system (anyOf 1) | string | Alternative | Operating system of the asset, null when none is recorded Known values: ANDROID_PHONE, ANDROID_TABLET, CHROME_OS, IOS_PHONE, IOS_TABLET, LINUX, MACOS, WINDOWS |
operating_system (anyOf 2) | null | Alternative | |
ownership | Model | Required within parent | Expand Update asset — 200 response body — data ownership Asset owner |
product | Model | Required within parent | Expand Update asset — 200 response body — data product Product details |
public_id | string | Required within parent | Public identifier of the item |
purchase_date | JSON | Required within parent | |
purchase_date (anyOf 1) | string | Alternative | Purchase date of the asset Format: date |
purchase_date (anyOf 2) | null | Alternative | Purchase date of the asset Format: date |
purchase_value | JSON | Required within parent | Purchase value of the asset |
purchase_value (anyOf 1) | Model | Alternative | Expand Update asset — 200 response body — data purchase value Purchase value of the asset |
purchase_value (anyOf 2) | null | Alternative | |
serial_number | JSON | Required within parent | |
serial_number (anyOf 1) | string | Alternative | Asset serial number |
serial_number (anyOf 2) | null | Alternative | Asset serial number |
status | Model | Required within parent | Expand Update asset — 200 response body — data status Current state of the asset |
updated_at | string | Required within parent | Last update timestamp of the asset Format: date-time |
Referenced models: Update asset — 200 response body — data assigned user Details of the user with asset possession, Update asset — 200 response body — data actions, Update asset — 200 response body — data / assigned_warehouse / ownership: DEEL, ORGANIZATION, warehouse type: CLEARANCE, DEEL, ORGANIZATION, Update asset — 200 response body — data keyboard layout string, Update asset — 200 response body — data ownership, Update asset — 200 response body — data product, Update asset — 200 response body — data purchase value Purchase value of the asset, Update asset — 200 response body — data status
Assign asset to new holder — request body — body data collection address country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Country the asset is being picked up from. Overrides the country the asset-action validator derives from asset state. One of: 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 |
Assign asset to new holder — request body — body data shipment insurance purchase details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Purchase details Deel records against the asset. Omit to fall back to purchase details already stored on the asset, if any. Must be omitted when `is_waived` is true. |
date | string | Required within parent | Date the asset was purchased. Format: date |
price | Model | Required within parent | Expand Assign asset to new holder — request body — body data shipment insurance purchase details price Purchase price paid for the asset. |
Referenced models: Assign asset to new holder — request body — body data shipment insurance purchase details price
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.itassets_collectitasset_v2026_09_15. Catalog operation: itassets_collectitasset_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-service-requests:write"]
Pinned headers: {"X-Version": "2026-09-15"}