CreateOrderResponseServiceModel_OrderItem

An item included in an order

NameDescriptionTypeAdditional Information
LicenseCategoryName

The identifier for a particular product on a license. In the majority of cases, one license has one category. In the case of GSM and Pillr licenses, a license may have one primary category and many secondary categories (e.g. SECA, SDNS, PLRCS).

string

None.

LicenseKeycodeTypeId

An identifier of the keycode type of a license.

Possible values are: 1 = standard license, 3 = parent license.

string

None.

Seats

The number of licensed seats

integer

None.

Quantity

The ordered quantity

integer

None.

UnitPrice

The unit price of the item

decimal number

None.

ItemHierarchyId

An identifier specifying whether this item is a primary or secondary product. Secondary products have an 'ItemHierarchyId' of 2 and represent products dependent on a primary product. Examples include SDNS (Webroot DNS Protection) and SECA (Webroot Security Awareness Training) products provisioned as part of an item whose primary product is SAEP.

integer

None.

ItemBundleId

The bundle identifier for this order item.

integer

None.

KeyCode

Key code associated with the item

string

None.

ProductDescription

Description of the ordered product

string

None.

ProductTypeDescription

Type of the ordered product

string

None.

LicenseAttributeValue

A value which indicates the product usage model for this item. Digit one defines the order type (1 = MSP, 2 = reseller). Digit two determines which terms a license is based on (1 = monthly, 2 = annually). Digit three refers to the associated billing model (0 = sold, 1 = overage, 2 = utility). As an example, 210 stands for "Reseller Monthly Sold".

integer

None.

LicenseAttributeValueDescription

A description of the license attribute value assigned to this item.

string

None.

LicenseAttributeDescription

A description of this license attribute.

string

None.

UsagePricingModelId

A value which indicates how usage is calculated for this item. Only applicable to certain license categories like OTSF.

integer

None.

UsagePricingModelName

The name of the usage pricing model as defined by UsagePricingModelId.

string

None.

VaultId

The data center used for this item. Note that ids are associated to license categories. As an example, a value of '1' defines a data center in the US for CBEP. Supported values are:

  • CBEP:
    • 1 = US
    • 2 = EMEA
    • 3 = CA
    • 4 = FR
    • 5 = APAC
    • 15 = AU
    • 16 = UK
  • OTSF
    • 8 = East US 2 (Virginia)
    • 9 = Australia East (New South Wales)
    • 10 = Canada Central (Toronto)
    • 11 = France Central (Paris)
    • 12 = UK South (London)
    • 13 = Germany

integer

None.

VaultName

The name of the datacenter vault associated with VaultId.

string

None.

ProductPlatformId

Platform used by this item (applicable to CBEP only). Currently supported values are:

  • 1 = Carbonite. Valid for LicenseKeycodeTypeId 3 and 1.
  • 2 = Azure EA. Valid for Business Single Site in Reseller Cart (LicenseKeycodeTypeId=1).
  • 3 = OnPrem. Valid for Business Single Site in Reseller Cart (LicenseKeycodeTypeId=1).

integer

None.

ProductPlatformName

A textual representation of ProductPlatformId.

string

None.

RetentionModelId

Number of years data is retained. Legitimate values are 1 (for one year) or 2 (for seven years).

integer

None.

RetentionModelName

A textual representation of RetentionModelId.

string

None.

ProductPricingLevelId

Pricing level used for this item.

integer

None.

ProductPricingLevelDescription

A textual representation of the ProductPricingLevelId field.

string

None.

CustomAttribute

Custom value which may be set by ECom depending on the use case.

string

None.