Product
SoftLayer_Product_Item

Overview

The SoftLayer_Product_Item data type contains general information relating to a single SoftLayer product.

Local Properties

capacity

Some Product Items have capacity information such as RAM and bandwidth, and others. This provides the numerical representation of the capacity given in the description of this product item.

Type:

decimal

description

A product's description

Type:

string

id

A product's internal identification number

Type:

integer

itemTaxCategoryId

A products tax category internal identification number

Type:

integer

keyName

A unique key name for the product.

Type:

string

longDescription

Detailed product description

Type:

string

softwareDescriptionId

The unique identifier of the SoftLayer_Software_Description tied to this item.

Type:

integer

units

The unit of measurement that a product item is measured in.

Type:

string

upgradeItemId

A products upgrade item's internal identification number

Type:

integer

Relational & Count Properties

Relational Properties can be queried by object mask
activePresaleEventCount

A count of

Type:

unsignedLong

activePresaleEvents
activeUsagePriceCount

A count of active usage based prices.

Type:

unsignedLong

activeUsagePrices

Active usage based prices.

attributeCount

A count of the attribute values for a product item. These are additional properties that give extra information about the product being sold.

Type:

unsignedLong

attributes

The attribute values for a product item. These are additional properties that give extra information about the product being sold.

availabilityAttributeCount

A count of attributes that govern when an item may no longer be available.

Type:

unsignedLong

availabilityAttributes

Attributes that govern when an item may no longer be available.

billingType

An item's special billing type, if applicable.

Type:

string

bundle

An item's included product item references. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item_Bundles objects. See the SoftLayer_Product_Item::bundleItems property for bundle of SoftLayer_Product_Item of objects.

bundleCount

A count of an item's included product item references. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item_Bundles objects. See the SoftLayer_Product_Item::bundleItems property for bundle of SoftLayer_Product_Item of objects.

Type:

unsignedLong

bundleItemCount

A count of an item's included products. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item objects.

Type:

unsignedLong

bundleItems

An item's included products. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item objects.

capacityMaximum

When the product capacity is best described as a range, this holds the ceiling of the range.

Type:

string

capacityMinimum

When the product capacity is best described as a range, this holds the floor of the range.

Type:

string

capacityRestrictedProductFlag

This flag indicates that this product is restricted by a capacity on a related product.

Type:

boolean

categories

An item's associated item categories.

categoryCount

A count of an item's associated item categories.

Type:

unsignedLong

configurationTemplateCount

A count of some product items have configuration templates which can be used to during provisioning of that product.

Type:

unsignedLong

configurationTemplates

Some product items have configuration templates which can be used to during provisioning of that product.

conflicts

An item's conflicts. For example, McAfee LinuxShield cannot be ordered with Windows. It was not meant for that operating system and as such is a conflict.

coreRestrictedItemFlag

This flag indicates that this product is restricted by the number of cores on the compute instance. This is deprecated. Use getCapacityRestrictedProductFlag

Type:

boolean

downgradeItem

Some product items have a downgrade path. This is the first product item in the downgrade path.

downgradeItemCount

A count of some product items have a downgrade path. These are those product items.

Type:

unsignedLong

downgradeItems

Some product items have a downgrade path. These are those product items.

globalCategoryConflicts

An item's category conflicts. For example, 10 Gbps redundant network functionality cannot be ordered with a secondary GPU and as such is a conflict.

hardwareGenericComponentModel

The generic hardware component that this item represents.

hideFromPortalFlag
Type:

boolean

inventory

An item's inventory status per datacenter.

inventoryCount

A count of an item's inventory status per datacenter.

Type:

unsignedLong

isEngineeredServerProduct

Flag to indicate the server product is engineered for a multi-server solution. (Deprecated)

Type:

boolean

itemCategory

An item's primary item category.

localDiskFlag
Type:

boolean

locationConflicts

An item's location conflicts. For example, Dual Path network functionality cannot be ordered in WDC and as such is a conflict.

objectStorageClusterGeolocationType
Type:

string

objectStorageItemFlag
Type:

boolean

objectStorageServiceClass
Type:

string

packageCount

A count of a collection of all the SoftLayer_Product_Package(s) in which this item exists.

Type:

unsignedLong

packages

A collection of all the SoftLayer_Product_Package(s) in which this item exists.

physicalCoreCapacity

The number of cores that a processor has.

Type:

string

presaleEventCount

A count of

Type:

unsignedLong

presaleEvents
priceCount

A count of a product item's prices.

Type:

unsignedLong

prices

A product item's prices.

requirements

If an item must be ordered with another item, it will have a requirement item here.

ruleCount

A count of an item's rules. This includes the requirements and conflicts to resources that an item has.

Type:

unsignedLong

rules

An item's rules. This includes the requirements and conflicts to resources that an item has.

softwareDescription

The SoftLayer_Software_Description tied to this item. This will only be populated for software items.

taxCategory

An item's tax category, if applicable.

thirdPartyPolicyAssignmentCount

A count of third-party policy assignments for this product.

Type:

unsignedLong

thirdPartyPolicyAssignments

Third-party policy assignments for this product.

thirdPartySupportVendor

The 3rd party vendor for a support subscription item. (Deprecated)

Type:

string

totalPhysicalCoreCapacity

The total number of physical processing cores (excluding virtual cores / hyperthreads) for this server.

Type:

integer

totalPhysicalCoreCount

Shows the total number of cores. This is deprecated. Use getCapacity for guest_core products and getTotalPhysicalCoreCapacity for server products

Type:

integer

totalProcessorCapacity

The total number of processors for this server.

Type:

integer

upgradeItem

Some product items have an upgrade path. This is the next product item in the upgrade path.

upgradeItemCount

A count of some product items have an upgrade path. These are those upgrade product items.

Type:

unsignedLong

upgradeItems

Some product items have an upgrade path. These are those upgrade product items.