Skip to content

Deel: IT products schemas

26 Deel schemas with complete fields and constraints.

← IT products operations · All schemas

List products in the catalog — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List products in the catalog — 200 response body — data item
has_morebooleanRequired within parentWhether there are more results available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to the next page
next_cursor (anyOf 2)nullAlternativeCursor to the next page
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of records
Format: int64
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List products in the catalog — 200 response body — data item

List products in the catalog — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
brandstringRequired within parentCompany that produced the product
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
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

Referenced models: Retrieve a product's catalog details — 200 response body — data images item, Retrieve a product's catalog details — 200 response body — data category

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

FieldTypePresenceDescription and constraints
$objectRootStructured hardware detail — nullable when no hardware spec is recorded (accessories, consumables)
display_sizeJSONRequired within parent
display_size (anyOf 1)stringAlternativeDiagonal display size in inches (devices with a screen only)
display_size (anyOf 2)nullAlternativeDiagonal display size in inches (devices with a screen only)
has_display_portJSONRequired within parent
has_display_port (anyOf 1)booleanAlternativeWhether the device has a DisplayPort connection (laptops, monitors)
has_display_port (anyOf 2)nullAlternativeWhether the device has a DisplayPort connection (laptops, monitors)
has_hdmi_portJSONRequired within parent
has_hdmi_port (anyOf 1)booleanAlternativeWhether the device has an HDMI port (laptops, monitors)
has_hdmi_port (anyOf 2)nullAlternativeWhether the device has an HDMI port (laptops, monitors)
has_usb_c_video_inputJSONRequired within parent
has_usb_c_video_input (anyOf 1)booleanAlternativeWhether the monitor supports USB-C video input (monitors only)
has_usb_c_video_input (anyOf 2)nullAlternativeWhether the monitor supports USB-C video input (monitors only)
memory_gbJSONRequired within parent
memory_gb (anyOf 1)JSONAlternative
memory_gb (anyOf 1) (anyOf 1)integerAlternativeMemory (RAM) capacity in gigabytes (laptops, mobile devices, tablets)
Format: int64
memory_gb (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
memory_gb (anyOf 2)nullAlternativeMemory (RAM) capacity in gigabytes (laptops, mobile devices, tablets)
Format: int64
processorJSONRequired within parent
processor (anyOf 1)stringAlternativeProcessor model (laptops only)
processor (anyOf 2)nullAlternativeProcessor model (laptops only)
product_categoryModelRequired within parentExpand 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 category
Category of the product this hardware spec belongs to
storage_gbJSONRequired within parent
storage_gb (anyOf 1)JSONAlternative
storage_gb (anyOf 1) (anyOf 1)integerAlternativeStorage capacity in gigabytes (laptops, mobile devices, tablets)
Format: int64
storage_gb (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
storage_gb (anyOf 2)nullAlternativeStorage capacity in gigabytes (laptops, mobile devices, tablets)
Format: int64
storage_typeJSONRequired within parentStorage medium type (laptops only)
storage_type (anyOf 1)stringAlternativeStorage medium type (laptops only)
Known values: HDD, SSD
storage_type (anyOf 2)nullAlternative
usb_c_connectionsJSONRequired within parent
usb_c_connections (anyOf 1)JSONAlternative
usb_c_connections (anyOf 1) (anyOf 1)integerAlternativeNumber of USB-C connections (laptops, monitors)
Format: int64
usb_c_connections (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
usb_c_connections (anyOf 2)nullAlternativeNumber of USB-C connections (laptops, monitors)
Format: int64

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

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 category

FieldTypePresenceDescription and constraints
$stringRootCategory of the product this hardware spec belongs to
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 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 variants item available countries item

FieldTypePresenceDescription and constraints
$stringRootKnown values: 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

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

Retrieve a product's prices for a delivery country — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve a product's prices for a delivery country — 200 response body — data

Referenced models: Retrieve a product's prices for a delivery country — 200 response body — data

Retrieve a product's prices for a delivery country — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
countryModelRequired within parentExpand Retrieve a product's prices for a delivery country — 200 response body — data country
ISO 3166 alpha-2 code of the delivery country the prices apply to
pricesarrayRequired within parentOne price per variant and contract setting the organization can order for delivery to the country. Rows are grouped by variant, cheapest variant first (by its lowest total_price), then by SKU. A variant that cannot be priced for the country is left out.
prices[]ModelEach itemExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item
product_idstringRequired within parentUnique identifier of the product
Format: uuid

Referenced models: Retrieve a product's prices for a delivery country — 200 response body — data country, Retrieve a product's prices for a delivery country — 200 response body — data prices item

Retrieve a product's prices for a delivery country — 200 response body — data country

FieldTypePresenceDescription and constraints
$stringRootISO 3166 alpha-2 code of the delivery country the prices apply to
Known values: 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

Retrieve a product's prices for a delivery country — 200 response body — data prices item

FieldTypePresenceDescription and constraints
$objectRoot
asset_priceModelRequired within parentExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item asset price
Equipment price over the whole contract, storefront fee excluded
available_addonsJSONRequired within parent
available_addons (anyOf 1)arrayAlternativeService and warranty addons this price can be ordered with, and what each costs on top of it. Null unless the request has `extend=AVAILABLE_ADDONS`.
available_addons (anyOf 1)[]ModelEach itemExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item
available_addons (anyOf 2)nullAlternativeService and warranty addons this price can be ordered with, and what each costs on top of it. Null unless the request has `extend=AVAILABLE_ADDONS`.
available_addons (anyOf 2)[]ModelEach itemExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item
contract_settingModelRequired within parentExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item contract setting
Contract setting this price applies to. Submit it as `contract_setting` on `POST /rest/it/orders` to order at this price, leaving out null fields and adding `addons`, empty for none.
payments_countJSONRequired within parent
payments_count (anyOf 1)integerAlternativeNumber of payments over the contract. 1 for purchases and upfront rentals.
Format: int64
payments_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
price_per_paymentModelRequired within parentExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item price per payment
Amount charged per payment, storefront fee included. Addons are priced separately in available_addons.
skuJSONRequired within parent
sku (anyOf 1)stringAlternativeSKU of the variant
sku (anyOf 2)nullAlternativeSKU of the variant
storefront_feeModelRequired within parentExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item storefront fee
Storefront fee over the whole contract
total_priceModelRequired within parentExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item total price
Total over the whole contract: asset_price plus storefront_fee. Addons are priced separately in available_addons.
variant_idstringRequired within parentUnique identifier of the variant this price is for. Submit it as `variant_id` on `POST /rest/it/orders`.
Format: uuid

Referenced models: Retrieve a product's prices for a delivery country — 200 response body — data prices item asset price, Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item, Retrieve a product's prices for a delivery country — 200 response body — data prices item contract setting, Retrieve a product's prices for a delivery country — 200 response body — data prices item price per payment, Retrieve a product's prices for a delivery country — 200 response body — data prices item storefront fee, Retrieve a product's prices for a delivery country — 200 response body — data prices item total price

Retrieve a product's prices for a delivery country — 200 response body — data prices item asset price

FieldTypePresenceDescription and constraints
$objectRootEquipment price over the whole contract, storefront fee excluded
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item

FieldTypePresenceDescription and constraints
$objectRoot
addon_idstringRequired within parentUnique identifier of the addon
Format: uuid
billingstringRequired within parentHow the addon is charged: PER_DEVICE on the device's contract, INCLUDED at no extra cost, or ORGANIZATION_CONTRACT as a seat on the organization's addon contract (see is_contract_seat_available).
Known values: INCLUDED, ORGANIZATION_CONTRACT, PER_DEVICE
bundleJSONRequired within parentWhich addon this is. Submit it as `bundle` in `contract_setting.addons[]` on `POST /rest/it/orders`, with `payment_schema` set to the price's payment schema (`UPFRONT` for a purchase). Null when the addon cannot be ordered through the API.
bundle (anyOf 1)ModelAlternativeExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item bundle string
bundle (anyOf 2)nullAlternative
duration_monthsJSONRequired within parent
duration_months (anyOf 1)integerAlternativeHow long the addon covers the device, in months. Submit it as `duration_months` with a service on `POST /rest/it/orders`, since a service can come in several lengths. Leave it out for a warranty, whose length follows the service.
Format: int64
duration_months (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_contract_seat_availableJSONRequired within parent
is_contract_seat_available (anyOf 1)booleanAlternativeFor ORGANIZATION_CONTRACT billing, whether the contract has a free seat for this addon. When false, ordering it adds a seat for the months left on the contract, billed on the contract's schedule: monthly, yearly or once upfront. Null for other billing.
is_contract_seat_available (anyOf 2)nullAlternativeFor ORGANIZATION_CONTRACT billing, whether the contract has a free seat for this addon. When false, ordering it adds a seat for the months left on the contract, billed on the contract's schedule: monthly, yearly or once upfront. Null for other billing.
is_it_seat_requiredbooleanRequired within parentWhether the addon can only be ordered for a worker who holds an IT seat
namestringRequired within parentPublic name of the addon
payments_countJSONRequired within parent
payments_count (anyOf 1)integerAlternativeNumber of payments for the addon
Format: int64
payments_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
price_per_paymentModelRequired within parentExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item price per payment
Amount charged per payment. For a new seat on a yearly contract, the first payment only covers the months up to the contract's renewal date, so it can be smaller.
requires_service_monthsJSONRequired within parent
requires_service_months (anyOf 1)arrayAlternativeFor a warranty, the service lengths in months it can be ordered with, since a warranty only comes with a service. A service is ordered with one warranty whose list includes its length. Null for a service.
requires_service_months (anyOf 1)[]JSONEach item
requires_service_months (anyOf 1)[] (anyOf 1)integerAlternativeFormat: int64
requires_service_months (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requires_service_months (anyOf 2)nullAlternativeFor a warranty, the service lengths in months it can be ordered with, since a warranty only comes with a service. A service is ordered with one warranty whose list includes its length. Null for a service.
requires_service_months (anyOf 2)[]JSONEach item
requires_service_months (anyOf 2)[] (anyOf 1)integerAlternativeFormat: int64
requires_service_months (anyOf 2)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_priceModelRequired within parentExpand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item total price
Total charged for the addon across all its payments
typestringRequired within parentKind of addon
Known values: SERVICE, WARRANTY

Referenced models: Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item bundle string, Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item price per payment, Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item total price

Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item bundle string

FieldTypePresenceDescription and constraints
$stringRootWhich addon this is. Submit it as `bundle` in `contract_setting.addons[]` on `POST /rest/it/orders`, with `payment_schema` set to the price's payment schema (`UPFRONT` for a purchase). Null when the addon cannot be ordered through the API.
Known values: DLM, DLM_PLUS, GLOBAL_WARRANTY, STANDARD_AND_LOANER, STANDARD_SERVICE, STANDARD_WARRANTY

Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item price per payment

FieldTypePresenceDescription and constraints
$objectRootAmount charged per payment. For a new seat on a yearly contract, the first payment only covers the months up to the contract's renewal date, so it can be smaller.
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item total price

FieldTypePresenceDescription and constraints
$objectRootTotal charged for the addon across all its payments
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Retrieve a product's prices for a delivery country — 200 response body — data prices item contract setting

FieldTypePresenceDescription and constraints
$objectRootContract setting this price applies to. Submit it as `contract_setting` on `POST /rest/it/orders` to order at this price, leaving out null fields and adding `addons`, empty for none.
acquisition_typestringRequired within parentHow the equipment is acquired
Known values: PURCHASE, RENTAL, REUSE
payment_schemaJSONRequired within parentHow the rental is billed. Null for purchases, which are paid upfront.
payment_schema (anyOf 1)stringAlternativeHow the rental is billed. Null for purchases, which are paid upfront.
Known values: MONTHLY, UPFRONT
payment_schema (anyOf 2)nullAlternative
rental_termJSONRequired within parentRental term length. Null for purchases.
rental_term (anyOf 1)stringAlternativeRental term length. Null for purchases.
Known values: MONTH_12, MONTH_24
rental_term (anyOf 2)nullAlternative

Retrieve a product's prices for a delivery country — 200 response body — data prices item price per payment

FieldTypePresenceDescription and constraints
$objectRootAmount charged per payment, storefront fee included. Addons are priced separately in available_addons.
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Retrieve a product's prices for a delivery country — 200 response body — data prices item storefront fee

FieldTypePresenceDescription and constraints
$objectRootStorefront fee over the whole contract
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

Retrieve a product's prices for a delivery country — 200 response body — data prices item total price

FieldTypePresenceDescription and constraints
$objectRootTotal over the whole contract: asset_price plus storefront_fee. Addons are priced separately in available_addons.
amountstringRequired within parentAmount
Format: decimal
currencyModelRequired within parentExpand Retrieve the IT seat subscription — 200 response body — data monthly seat price currency
Three-letter currency code for the price

Referenced models: Retrieve the IT seat subscription — 200 response body — data monthly seat price currency

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.