Skip to content

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.

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 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_products.retrieve_an_it_product(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.product_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.countrystringOptional
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a product’s catalog details — 200 response body

Referenced models: Retrieve a product’s catalog details — 200 response body

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

Retrieve a product's catalog details — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
available_addonsarrayRequired within parentMenu 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[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data available addons item
brandstringRequired within parentCompany that produced the product
categoryModelRequired within parentExpand Retrieve a product's catalog details — 200 response body — data category
Product category
descriptionstringRequired within parentFree-text product description
idstringRequired within parentUnique identifier of the product
Format: uuid
imagesarrayRequired within parentOrdered list of product images. The first element is the cover image.
images[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data images item
namestringRequired within parentProduct name
product_hardware_specJSONRequired within parentStructured hardware detail — nullable when no hardware spec is recorded (accessories, consumables)
product_hardware_spec (anyOf 1)ModelAlternativeExpand 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)nullAlternative
public_idstringRequired within parentPublic identifier of the product
variantsarrayRequired within parentCatalog variants for this product — one per SKU
variants[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the image
Format: uuid
urlstringRequired within parentPublic URL of the image
Retrieve a product's catalog details — 200 response body — data variants item
FieldTypePresenceDescription and constraints
$objectRoot
allowed_acquisition_typesarrayRequired within parentAcquisition types allowed for this variant
allowed_acquisition_types[]stringEach itemKnown values: PURCHASE, RENTAL, REUSE
allowed_rental_termsarrayRequired within parentRental terms permitted for this variant. Empty for non-rental variants.
allowed_rental_terms[]stringEach itemKnown values: MONTH_12, MONTH_24
available_countriesarrayRequired within parentISO 3166 alpha-2 country codes where this variant can be ordered
available_countries[]ModelEach itemExpand Retrieve a product's catalog details — 200 response body — data variants item available countries item
idstringRequired within parentUnique identifier of the variant
Format: uuid
imageJSONRequired within parentImage of this variant, null when the variant has no image
image (anyOf 1)ModelAlternativeExpand Retrieve a product's catalog details — 200 response body — data variants item image id, url
image (anyOf 2)nullAlternative
keyboard_layoutJSONRequired within parentPhysical keyboard layout (laptops only)
keyboard_layout (anyOf 1)ModelAlternativeExpand Retrieve a product's catalog details — 200 response body — data variants item keyboard layout Physical keyboard layout (laptops only)
keyboard_layout (anyOf 2)nullAlternative
operating_systemJSONRequired within parentOperating system installed on this variant (devices only)
operating_system (anyOf 1)stringAlternativeOperating 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)nullAlternative
public_idstringRequired within parentPublic identifier of the variant
sizeJSONRequired within parent
size (anyOf 1)stringAlternativePhysical size or dimension label — style + size together uniquely identify a variant within a product
size (anyOf 2)nullAlternativePhysical size or dimension label — style + size together uniquely identify a variant within a product
skuJSONRequired within parent
sku (anyOf 1)stringAlternativeSKU of the variant
sku (anyOf 2)nullAlternativeSKU of the variant
styleJSONRequired within parent
style (anyOf 1)stringAlternativeMarketing style (colour, tier, etc.) — style + size together uniquely identify a variant within a product
style (anyOf 2)nullAlternativeMarketing 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
FieldTypePresenceDescription and constraints
$stringRootProduct 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
FieldTypePresenceDescription and constraints
$objectRoot
bundleJSONRequired within parentWhich 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)stringAlternativeWhich 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)nullAlternative
idstringRequired within parentUnique identifier of the addon
Format: uuid
is_premiumbooleanRequired within parentWhether the addon is a premium (paid) offering. Free/default addons are false.
namestringRequired within parentPublic name of the addon
typestringRequired within parentKind 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
FieldTypePresenceDescription and constraints
$objectRootImage of this variant, null when the variant has no image
idstringRequired within parentUnique identifier of the image
Format: uuid
urlstringRequired within parentPublic URL of the image
Retrieve a product's catalog details — 200 response body — data variants item keyboard layout Physical keyboard layout (laptops only)
FieldTypePresenceDescription and constraints
$stringRootPhysical 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

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"}

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.