Deel: Retrieve a product's catalog details
Deel itProducts.retrieveAnItProduct: arguments, response, policy and SDK examples.
← IT products operations · Get started
Operation deel.itproducts_retrieveanitproduct_v2026_09_17
Provider route: GET /it/products/{product_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["itProducts"]["retrieveAnItProduct"]>[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.itProducts.retrieveAnItProduct(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_products.retrieve_an_it_product(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.product_id | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.country | string | Optional | |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
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 a product’s catalog details — 200 response body |
Referenced models: Retrieve a product’s catalog details — 200 response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Retrieve a product's catalog details — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a product's catalog details — 200 response body — data |
Referenced models: Retrieve a product's catalog details — 200 response body — data
Retrieve a product's catalog details — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
available_addons | array | Required within parent | Menu of addons the organization has available to attach on POST /orders. Callers submit an addon by `bundle` on the order's contract_setting.addons[]. Pricing is not returned here — the invoice reveals amounts once the order lands. |
available_addons[] | Model | Each item | Expand Retrieve a product's catalog details — 200 response body — data available addons item |
brand | string | Required within parent | Company that produced the product |
category | Model | Required within parent | Expand Retrieve a product's catalog details — 200 response body — data category Product category |
description | string | Required within parent | Free-text product description |
id | string | Required within parent | Unique identifier of the product Format: uuid |
images | array | Required within parent | Ordered list of product images. The first element is the cover image. |
images[] | Model | Each item | Expand Retrieve a product's catalog details — 200 response body — data images item |
name | string | Required within parent | Product name |
product_hardware_spec | JSON | Required within parent | Structured hardware detail — nullable when no hardware spec is recorded (accessories, consumables) |
product_hardware_spec (anyOf 1) | Model | Alternative | Expand Retrieve a product's catalog details — 200 response body — data product hardware spec display size, has display port, has hdmi port, has usb c video input, memory gb, processor, product category, storage gb, storage type, usb c connections |
product_hardware_spec (anyOf 2) | null | Alternative | |
public_id | string | Required within parent | Public identifier of the product |
variants | array | Required within parent | Catalog variants for this product — one per SKU |
variants[] | Model | Each item | Expand Retrieve a product's catalog details — 200 response body — data variants item |
Referenced models: Retrieve a product's catalog details — 200 response body — data images item, Retrieve a product's catalog details — 200 response body — data variants item, Retrieve a product's catalog details — 200 response body — data category, Retrieve a product's catalog details — 200 response body — data available addons item, Retrieve a product's catalog details — 200 response body — data product hardware spec display size, has display port, has hdmi port, has usb c video input, memory gb, processor, product category, storage gb, storage type, usb c connections
Retrieve a product's catalog details — 200 response body — data images item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the image Format: uuid |
url | string | Required within parent | Public URL of the image |
Retrieve a product's catalog details — 200 response body — data variants item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowed_acquisition_types | array | Required within parent | Acquisition types allowed for this variant |
allowed_acquisition_types[] | string | Each item | Known values: PURCHASE, RENTAL, REUSE |
allowed_rental_terms | array | Required within parent | Rental terms permitted for this variant. Empty for non-rental variants. |
allowed_rental_terms[] | string | Each item | Known values: MONTH_12, MONTH_24 |
available_countries | array | Required within parent | ISO 3166 alpha-2 country codes where this variant can be ordered |
available_countries[] | Model | Each item | Expand Retrieve a product's catalog details — 200 response body — data variants item available countries item |
id | string | Required within parent | Unique identifier of the variant Format: uuid |
image | JSON | Required within parent | Image of this variant, null when the variant has no image |
image (anyOf 1) | Model | Alternative | Expand Retrieve a product's catalog details — 200 response body — data variants item image id, url |
image (anyOf 2) | null | Alternative | |
keyboard_layout | JSON | Required within parent | Physical keyboard layout (laptops only) |
keyboard_layout (anyOf 1) | Model | Alternative | Expand Retrieve a product's catalog details — 200 response body — data variants item keyboard layout Physical keyboard layout (laptops only) |
keyboard_layout (anyOf 2) | null | Alternative | |
operating_system | JSON | Required within parent | Operating system installed on this variant (devices only) |
operating_system (anyOf 1) | string | Alternative | Operating system installed on this variant (devices only) Known values: ANDROID_PHONE, ANDROID_TABLET, CHROME_OS, IOS_PHONE, IOS_TABLET, LINUX, MACOS, WINDOWS |
operating_system (anyOf 2) | null | Alternative | |
public_id | string | Required within parent | Public identifier of the variant |
size | JSON | Required within parent | |
size (anyOf 1) | string | Alternative | Physical size or dimension label — style + size together uniquely identify a variant within a product |
size (anyOf 2) | null | Alternative | Physical size or dimension label — style + size together uniquely identify a variant within a product |
sku | JSON | Required within parent | |
sku (anyOf 1) | string | Alternative | SKU of the variant |
sku (anyOf 2) | null | Alternative | SKU of the variant |
style | JSON | Required within parent | |
style (anyOf 1) | string | Alternative | Marketing style (colour, tier, etc.) — style + size together uniquely identify a variant within a product |
style (anyOf 2) | null | Alternative | Marketing style (colour, tier, etc.) — style + size together uniquely identify a variant within a product |
Referenced models: Retrieve a product's catalog details — 200 response body — data variants item image id, url, Retrieve a product's catalog details — 200 response body — data variants item available countries item, Retrieve a product's catalog details — 200 response body — data variants item keyboard layout Physical keyboard layout (laptops only)
Retrieve a product's catalog details — 200 response body — data category
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Product category Known values: ADAPTER, CABLE, CHAIR, CHARGER, COMPACT_DESKTOP, DESK, DESKTOP, DESK_RISER, DESK_TIDY, DOCKING_STATION, DONGLE, FOOTREST, HEADSET, KEYBOARD, LAPTOP, LAPTOP_STAND, MICE_TRACKPAD, MOBILE_DEVICE, MONITOR, MONITOR_ARM, OTHER, PRINTER, SHREDDER, STANDING_MAT, TABLET, TASK_LIGHT, WEBCAM, WELCOME_PACK, WIFI_RANGE_EXTENDER |
Retrieve a product's catalog details — 200 response body — data available addons item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bundle | JSON | Required within parent | Which addon this is. Submit it as `bundle` in `contract_setting.addons[]` on `POST /rest/it/orders`. Null when the addon cannot be ordered through the API. |
bundle (anyOf 1) | string | Alternative | Which addon this is. Submit it as `bundle` in `contract_setting.addons[]` on `POST /rest/it/orders`. Null when the addon cannot be ordered through the API. Known values: DLM, DLM_PLUS, GLOBAL_WARRANTY, STANDARD_AND_LOANER, STANDARD_SERVICE, STANDARD_WARRANTY |
bundle (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the addon Format: uuid |
is_premium | boolean | Required within parent | Whether the addon is a premium (paid) offering. Free/default addons are false. |
name | string | Required within parent | Public name of the addon |
type | string | Required within parent | Kind of addon — SERVICE bundles cover service/support, WARRANTY bundles cover extended cover. Known values: SERVICE, WARRANTY |
Retrieve a product's catalog details — 200 response body — data variants item image id, url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Image of this variant, null when the variant has no image |
id | string | Required within parent | Unique identifier of the image Format: uuid |
url | string | Required within parent | Public URL of the image |
Retrieve a product's catalog details — 200 response body — data variants item keyboard layout Physical keyboard layout (laptops only)
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Physical keyboard layout (laptops only) Known values: ARABIC, BELARUSIAN_JCUKEN, BELGIAN_AZERTY, BRAZILIAN_PORTUGUESE_QWERTY, BULGARIAN, CANADIAN_MULTILINGUAL_STANDARD_QWERTY, COLEMAK, CROATIAN_QWERTZ, CZECH_QWERTY, DANISH_QWERTY, DUTCH_QWERTY, DVORAK_ENGLISH, DVORAK_FRENCH, EGYPTIAN_LOCAL, ENGLISH_RUSSIAN_QWERTY, EU_STANDARD_QWERTY, FRENCH_AZERTY, FRENCH_BEPO, GERMAN_QWERTZ, GREEK, HEBREW, HUNGARIAN_QWERTZ, INDIAN_QWERTY, INTERNATIONAL_ENGLISH_QWERTY, ITALIAN_QWERTY, JAPANESE_QWERTY, KOREAN_QWERTY, LATAM_QWERTY, NORWEGIAN_QWERTY, POLISH_QWERTY, PORTUGUESE_QWERTY, RUSSIAN_JCUKEN, SERBIAN_CYRILLIC, SERBIAN_LATIN_QWERTZ, SLOVAK_QWERTZ, SPANISH_QWERTY, SWEDISH_QWERTY, SWISS_FRENCH_QWERTZ, SWISS_GERMAN_QWERTZ, THAI, TURKISH_QWERTY, UKRAINIAN_JCUKEN, UK_ENGLISH_QWERTY, UNKNOWN, US_ENGLISH_QWERTY, VIETNAMESE, WORKMAN |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.itproducts_retrieveanitproduct_v2026_09_17. Catalog operation: itproducts_retrieveanitproduct_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-products:read"]
Pinned headers: {"X-Version": "2026-09-17"}