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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand List products in the catalog — 200 response body — data item |
has_more | boolean | Required within parent | Whether there are more results available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to the next page |
next_cursor (anyOf 2) | null | Alternative | Cursor to the next page |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of records Format: int64 |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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 |
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 |
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
| 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 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 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 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 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Structured hardware detail — nullable when no hardware spec is recorded (accessories, consumables) |
display_size | JSON | Required within parent | |
display_size (anyOf 1) | string | Alternative | Diagonal display size in inches (devices with a screen only) |
display_size (anyOf 2) | null | Alternative | Diagonal display size in inches (devices with a screen only) |
has_display_port | JSON | Required within parent | |
has_display_port (anyOf 1) | boolean | Alternative | Whether the device has a DisplayPort connection (laptops, monitors) |
has_display_port (anyOf 2) | null | Alternative | Whether the device has a DisplayPort connection (laptops, monitors) |
has_hdmi_port | JSON | Required within parent | |
has_hdmi_port (anyOf 1) | boolean | Alternative | Whether the device has an HDMI port (laptops, monitors) |
has_hdmi_port (anyOf 2) | null | Alternative | Whether the device has an HDMI port (laptops, monitors) |
has_usb_c_video_input | JSON | Required within parent | |
has_usb_c_video_input (anyOf 1) | boolean | Alternative | Whether the monitor supports USB-C video input (monitors only) |
has_usb_c_video_input (anyOf 2) | null | Alternative | Whether the monitor supports USB-C video input (monitors only) |
memory_gb | JSON | Required within parent | |
memory_gb (anyOf 1) | JSON | Alternative | |
memory_gb (anyOf 1) (anyOf 1) | integer | Alternative | Memory (RAM) capacity in gigabytes (laptops, mobile devices, tablets) Format: int64 |
memory_gb (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
memory_gb (anyOf 2) | null | Alternative | Memory (RAM) capacity in gigabytes (laptops, mobile devices, tablets) Format: int64 |
processor | JSON | Required within parent | |
processor (anyOf 1) | string | Alternative | Processor model (laptops only) |
processor (anyOf 2) | null | Alternative | Processor model (laptops only) |
product_category | Model | Required within parent | 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 category Category of the product this hardware spec belongs to |
storage_gb | JSON | Required within parent | |
storage_gb (anyOf 1) | JSON | Alternative | |
storage_gb (anyOf 1) (anyOf 1) | integer | Alternative | Storage capacity in gigabytes (laptops, mobile devices, tablets) Format: int64 |
storage_gb (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
storage_gb (anyOf 2) | null | Alternative | Storage capacity in gigabytes (laptops, mobile devices, tablets) Format: int64 |
storage_type | JSON | Required within parent | Storage medium type (laptops only) |
storage_type (anyOf 1) | string | Alternative | Storage medium type (laptops only) Known values: HDD, SSD |
storage_type (anyOf 2) | null | Alternative | |
usb_c_connections | JSON | Required within parent | |
usb_c_connections (anyOf 1) | JSON | Alternative | |
usb_c_connections (anyOf 1) (anyOf 1) | integer | Alternative | Number of USB-C connections (laptops, monitors) Format: int64 |
usb_c_connections (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
usb_c_connections (anyOf 2) | null | Alternative | Number of USB-C connections (laptops, monitors) Format: int64 |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Category 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
| 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 variants item available countries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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 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 |
Retrieve a product's prices for a delivery country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | Model | Required within parent | Expand 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 |
prices | array | Required within parent | One 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[] | Model | Each item | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item |
product_id | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | ISO 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
asset_price | Model | Required within parent | Expand 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_addons | JSON | Required within parent | |
available_addons (anyOf 1) | array | Alternative | Service 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)[] | Model | Each item | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item |
available_addons (anyOf 2) | null | Alternative | Service 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)[] | Model | Each item | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item |
contract_setting | Model | Required within parent | Expand 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_count | JSON | Required within parent | |
payments_count (anyOf 1) | integer | Alternative | Number of payments over the contract. 1 for purchases and upfront rentals. Format: int64 |
payments_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
price_per_payment | Model | Required within parent | Expand 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. |
sku | JSON | Required within parent | |
sku (anyOf 1) | string | Alternative | SKU of the variant |
sku (anyOf 2) | null | Alternative | SKU of the variant |
storefront_fee | Model | Required within parent | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item storefront fee Storefront fee over the whole contract |
total_price | Model | Required within parent | Expand 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_id | string | Required within parent | Unique 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Equipment price over the whole contract, storefront fee excluded |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
addon_id | string | Required within parent | Unique identifier of the addon Format: uuid |
billing | string | Required within parent | How 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 |
bundle | JSON | Required within parent | Which 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) | Model | Alternative | Expand Retrieve a product's prices for a delivery country — 200 response body — data prices item available addons null item bundle string |
bundle (anyOf 2) | null | Alternative | |
duration_months | JSON | Required within parent | |
duration_months (anyOf 1) | integer | Alternative | How 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_contract_seat_available | JSON | Required within parent | |
is_contract_seat_available (anyOf 1) | boolean | Alternative | For 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) | null | Alternative | For 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_required | boolean | Required within parent | Whether the addon can only be ordered for a worker who holds an IT seat |
name | string | Required within parent | Public name of the addon |
payments_count | JSON | Required within parent | |
payments_count (anyOf 1) | integer | Alternative | Number of payments for the addon Format: int64 |
payments_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
price_per_payment | Model | Required within parent | Expand 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_months | JSON | Required within parent | |
requires_service_months (anyOf 1) | array | Alternative | For 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)[] | JSON | Each item | |
requires_service_months (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
requires_service_months (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requires_service_months (anyOf 2) | null | Alternative | For 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)[] | JSON | Each item | |
requires_service_months (anyOf 2)[] (anyOf 1) | integer | Alternative | Format: int64 |
requires_service_months (anyOf 2)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_price | Model | Required within parent | Expand 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 |
type | string | Required within parent | Kind 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Which 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Total charged for the addon across all its payments |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
acquisition_type | string | Required within parent | How the equipment is acquired Known values: PURCHASE, RENTAL, REUSE |
payment_schema | JSON | Required within parent | How the rental is billed. Null for purchases, which are paid upfront. |
payment_schema (anyOf 1) | string | Alternative | How the rental is billed. Null for purchases, which are paid upfront. Known values: MONTHLY, UPFRONT |
payment_schema (anyOf 2) | null | Alternative | |
rental_term | JSON | Required within parent | Rental term length. Null for purchases. |
rental_term (anyOf 1) | string | Alternative | Rental term length. Null for purchases. Known values: MONTH_12, MONTH_24 |
rental_term (anyOf 2) | null | Alternative |
Retrieve a product's prices for a delivery country — 200 response body — data prices item price per payment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Amount charged per payment, storefront fee included. Addons are priced separately in available_addons. |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Storefront fee over the whole contract |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Total over the whole contract: asset_price plus storefront_fee. Addons are priced separately in available_addons. |
amount | string | Required within parent | Amount Format: decimal |
currency | Model | Required within parent | Expand 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