SoftLayer_Product_Item


SoftLayer_Product_Item

Description

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

Local


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


hardwareGenericComponentId

The hardware generic component model ID of the product.
Type: int


id

A product’s internal identification number
Type: int


itemTaxCategoryId

A products tax category internal identification number
Type: int


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


units

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


upgradeItemId

A products upgrade item’s internal identification number
Type: int

Relational


activeUsagePrices

Active usage based prices.
Type: SoftLayer_Product_Item_Price[]


attributes

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


availabilityAttributes

Attributes that govern when an item may no longer be available.
Type: SoftLayer_Product_Item_Attribute[]


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.
Type: SoftLayer_Product_Item_Bundles[]


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.
Type: SoftLayer_Product_Item[]


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.
Type: SoftLayer_Product_Item_Category[]


configurationTemplates

Some product items have configuration templates which can be used to during provisioning of that product.
Type: SoftLayer_Configuration_Template[]


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.
Type: SoftLayer_Product_Item_Resource_Conflict[]


coreRestrictedItemFlag

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


downgradeItem

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


downgradeItems

Some product items have a downgrade path. These are those product items.
Type: SoftLayer_Product_Item[]


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.
Type: SoftLayer_Product_Item_Resource_Conflict[]


hardwareGenericComponentModel

The generic hardware component that this item represents.
Type: SoftLayer_Hardware_Component_Model_Generic


hideFromPortalFlag

None
Type: boolean


inventory

DEPRECATED. An item’s inventory status per datacenter.
Type: SoftLayer_Product_Package_Inventory[]


isEngineeredServerProduct

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


itemCategory

An item’s primary item category.
Type: SoftLayer_Product_Item_Category


localDiskFlag

None
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.
Type: SoftLayer_Product_Item_Resource_Conflict[]


m2ControllerFlag

Indicates whether an item is a M.2 disk controller.
Type: boolean


m2DriveFlag

Indicates whether an item is a M.2 drive.
Type: boolean


minimumNvmeBays

The minimum number of bays that support NVMe SSDs.
Type: int


nvmeDiskFlag

Indicates whether an item is a NVMe SSD.
Type: boolean


objectStorageItemFlag

None
Type: boolean


objectStorageServiceClass

None
Type: string


packages

A collection of all the SoftLayer_Product_Package(s) in which this item exists.
Type: SoftLayer_Product_Package[]


pcieDriveFlag

Indicates whether an item is a PCIe drive.
Type: boolean


physicalCoreCapacity

The number of cores that a processor has.
Type: string


prices

A product item’s prices.
Type: SoftLayer_Product_Item_Price[]


requirements

If an item must be ordered with another item, it will have a requirement item here.
Type: SoftLayer_Product_Item_Requirement[]


rules

An item’s rules. This includes the requirements and conflicts to resources that an item has.
Type: SoftLayer_Product_Item_Rule[]


softwareDescription

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


speedSelectServerCoreCount

The total number of cores for a speed select server product.
Type: string


speedSelectServerFlag

Indicates a speed select server item.
Type: boolean


taxCategory

An item’s tax category, if applicable.
Type: SoftLayer_Product_Item_Tax_Category


thirdPartyPolicyAssignments

Third-party policy assignments for this product.
Type: SoftLayer_Product_Item_Policy_Assignment[]


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


totalPhysicalCoreCount

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


totalProcessorCapacity

The total number of processors for this server.
Type: int


upgradeItem

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


upgradeItems

Some product items have an upgrade path. These are those upgrade product items.
Type: SoftLayer_Product_Item[]

Count


activePresaleEventCount

A count of
Type: unsignedLong


activeUsagePriceCount

A count of active usage based prices.
Type: unsignedLong


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


availabilityAttributeCount

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


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


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


downgradeItemCount

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


inventoryCount

A count of dEPRECATED. An item’s inventory status per datacenter.
Type: unsignedLong


packageCount

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


presaleEventCount

A count of
Type: unsignedLong


priceCount

A count of a product item’s prices.
Type: unsignedLong


ruleCount

A count of an item’s rules. This includes the requirements and conflicts to resources that an item has.
Type: unsignedLong


thirdPartyPolicyAssignmentCount

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


upgradeItemCount

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