ProductOffering Data Type

Abstract Type
Subtypes
ProductTemplate, BundleTemplate, OfferTemplate
Implemented Interfaces
Serializable
Properties
name data type description
imagePath string
channels array of Channel
attachments array of DigitalResource
lifeCycleStatus LifeCycleStatusEnum
name string
businessAccountModels array of BusinessAccountModel
offerTemplateCategories array of OfferTemplateCategory
nameOrCode string
validTo number
validFrom number
Properties inherited from BusinessCFEntity
parentCFEntities array of object
uuid string
Properties inherited from BusinessEntity
parentEntityType object
code string
parentEntity BusinessEntity
description string
appendGeneratedCode boolean
descriptionOrCode string
Properties inherited from EnableEntity
active boolean
disabled boolean
Properties inherited from AuditableEntity
auditable Auditable
Properties inherited from BaseEntity
id number
transient boolean
version number

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "imagePath" : "...",
  "channels" : [ {
    "parentEntityType" : { },
    "code" : "...",
    "parentEntity" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "description" : "...",
    "appendGeneratedCode" : true,
    "descriptionOrCode" : "...",
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  }, {
    "parentEntityType" : { },
    "code" : "...",
    "parentEntity" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "description" : "...",
    "appendGeneratedCode" : true,
    "descriptionOrCode" : "...",
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  } ],
  "attachments" : [ {
    "mimeType" : "...",
    "uri" : "...",
    "productOfferings" : [ {
      "imagePath" : "...",
      "channels" : [ { }, { } ],
      "attachments" : [ { }, { } ],
      "lifeCycleStatus" : "IN_STUDY",
      "name" : "...",
      "businessAccountModels" : [ { }, { } ],
      "offerTemplateCategories" : [ { }, { } ],
      "nameOrCode" : "...",
      "validTo" : 12345,
      "validFrom" : 12345,
      "parentCFEntities" : [ { }, { } ],
      "uuid" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    }, {
      "imagePath" : "...",
      "channels" : [ { }, { } ],
      "attachments" : [ { }, { } ],
      "lifeCycleStatus" : "RETIRED",
      "name" : "...",
      "businessAccountModels" : [ { }, { } ],
      "offerTemplateCategories" : [ { }, { } ],
      "nameOrCode" : "...",
      "validTo" : 12345,
      "validFrom" : 12345,
      "parentCFEntities" : [ { }, { } ],
      "uuid" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    } ],
    "parentEntityType" : { },
    "code" : "...",
    "parentEntity" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "description" : "...",
    "appendGeneratedCode" : true,
    "descriptionOrCode" : "...",
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  }, {
    "mimeType" : "...",
    "uri" : "...",
    "productOfferings" : [ {
      "imagePath" : "...",
      "channels" : [ { }, { } ],
      "attachments" : [ { }, { } ],
      "lifeCycleStatus" : "ACTIVE",
      "name" : "...",
      "businessAccountModels" : [ { }, { } ],
      "offerTemplateCategories" : [ { }, { } ],
      "nameOrCode" : "...",
      "validTo" : 12345,
      "validFrom" : 12345,
      "parentCFEntities" : [ { }, { } ],
      "uuid" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    }, {
      "imagePath" : "...",
      "channels" : [ { }, { } ],
      "attachments" : [ { }, { } ],
      "lifeCycleStatus" : "OBSOLETE",
      "name" : "...",
      "businessAccountModels" : [ { }, { } ],
      "offerTemplateCategories" : [ { }, { } ],
      "nameOrCode" : "...",
      "validTo" : 12345,
      "validFrom" : 12345,
      "parentCFEntities" : [ { }, { } ],
      "uuid" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    } ],
    "parentEntityType" : { },
    "code" : "...",
    "parentEntity" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "description" : "...",
    "appendGeneratedCode" : true,
    "descriptionOrCode" : "...",
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  } ],
  "lifeCycleStatus" : "IN_TEST",
  "name" : "...",
  "businessAccountModels" : [ {
    "hierarchyType" : "C_UA",
    "logoPicture" : "...",
    "script" : {
      "sourcingRoles" : [ { }, { } ],
      "executionRoles" : [ { }, { } ],
      "sourceTypeEnum" : "JAVA",
      "error" : true,
      "scriptErrors" : [ { }, { } ],
      "script" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "moduleItems" : [ {
      "itemClassSimpleName" : "...",
      "itemCode" : "...",
      "meveoModule" : { },
      "appliesTo" : "...",
      "itemClass" : "...",
      "itemEntity" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    }, {
      "itemClassSimpleName" : "...",
      "itemCode" : "...",
      "meveoModule" : { },
      "appliesTo" : "...",
      "itemClass" : "...",
      "itemEntity" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    } ],
    "downloaded" : true,
    "installed" : true,
    "license" : "AGPL",
    "moduleSource" : "...",
    "parentEntityType" : { },
    "code" : "...",
    "parentEntity" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "description" : "...",
    "appendGeneratedCode" : true,
    "descriptionOrCode" : "...",
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  }, {
    "hierarchyType" : "S_CA",
    "logoPicture" : "...",
    "script" : {
      "sourcingRoles" : [ { }, { } ],
      "executionRoles" : [ { }, { } ],
      "sourceTypeEnum" : "JAVA",
      "error" : true,
      "scriptErrors" : [ { }, { } ],
      "script" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "moduleItems" : [ {
      "itemClassSimpleName" : "...",
      "itemCode" : "...",
      "meveoModule" : { },
      "appliesTo" : "...",
      "itemClass" : "...",
      "itemEntity" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    }, {
      "itemClassSimpleName" : "...",
      "itemCode" : "...",
      "meveoModule" : { },
      "appliesTo" : "...",
      "itemClass" : "...",
      "itemEntity" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    } ],
    "downloaded" : true,
    "installed" : true,
    "license" : "EPL",
    "moduleSource" : "...",
    "parentEntityType" : { },
    "code" : "...",
    "parentEntity" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "description" : "...",
    "appendGeneratedCode" : true,
    "descriptionOrCode" : "...",
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  } ],
  "offerTemplateCategories" : [ {
    "imagePath" : "...",
    "parentCategoryCode" : "...",
    "assignedToProductOffering" : true,
    "children" : [ { }, { } ],
    "productOffering" : [ {
      "imagePath" : "...",
      "channels" : [ { }, { } ],
      "attachments" : [ { }, { } ],
      "lifeCycleStatus" : "ACTIVE",
      "name" : "...",
      "businessAccountModels" : [ { }, { } ],
      "offerTemplateCategories" : [ { }, { } ],
      "nameOrCode" : "...",
      "validTo" : 12345,
      "validFrom" : 12345,
      "parentCFEntities" : [ { }, { } ],
      "uuid" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    }, {
      "imagePath" : "...",
      "channels" : [ { }, { } ],
      "attachments" : [ { }, { } ],
      "lifeCycleStatus" : "IN_STUDY",
      "name" : "...",
      "businessAccountModels" : [ { }, { } ],
      "offerTemplateCategories" : [ { }, { } ],
      "nameOrCode" : "...",
      "validTo" : 12345,
      "validFrom" : 12345,
      "parentCFEntities" : [ { }, { } ],
      "uuid" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    } ],
    "name" : "...",
    "orderLevel" : 12345,
    "descriptionOrCode" : "...",
    "parentCFEntities" : [ { }, { } ],
    "offerTemplateCategory" : { },
    "uuid" : "...",
    "parentEntityType" : { },
    "code" : "...",
    "parentEntity" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "description" : "...",
    "appendGeneratedCode" : true,
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  }, {
    "imagePath" : "...",
    "parentCategoryCode" : "...",
    "assignedToProductOffering" : true,
    "children" : [ { }, { } ],
    "productOffering" : [ {
      "imagePath" : "...",
      "channels" : [ { }, { } ],
      "attachments" : [ { }, { } ],
      "lifeCycleStatus" : "IN_DESIGN",
      "name" : "...",
      "businessAccountModels" : [ { }, { } ],
      "offerTemplateCategories" : [ { }, { } ],
      "nameOrCode" : "...",
      "validTo" : 12345,
      "validFrom" : 12345,
      "parentCFEntities" : [ { }, { } ],
      "uuid" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    }, {
      "imagePath" : "...",
      "channels" : [ { }, { } ],
      "attachments" : [ { }, { } ],
      "lifeCycleStatus" : "ACTIVE",
      "name" : "...",
      "businessAccountModels" : [ { }, { } ],
      "offerTemplateCategories" : [ { }, { } ],
      "nameOrCode" : "...",
      "validTo" : 12345,
      "validFrom" : 12345,
      "parentCFEntities" : [ { }, { } ],
      "uuid" : "...",
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    } ],
    "name" : "...",
    "orderLevel" : 12345,
    "descriptionOrCode" : "...",
    "parentCFEntities" : [ { }, { } ],
    "offerTemplateCategory" : { },
    "uuid" : "...",
    "parentEntityType" : { },
    "code" : "...",
    "parentEntity" : {
      "parentEntityType" : { },
      "code" : "...",
      "parentEntity" : { },
      "description" : "...",
      "appendGeneratedCode" : true,
      "descriptionOrCode" : "...",
      "active" : true,
      "disabled" : true,
      "auditable" : { },
      "id" : 12345,
      "transient" : true,
      "version" : 12345
    },
    "description" : "...",
    "appendGeneratedCode" : true,
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  } ],
  "nameOrCode" : "...",
  "validTo" : 12345,
  "validFrom" : 12345,
  "parentCFEntities" : [ { }, { } ],
  "uuid" : "...",
  "parentEntityType" : { },
  "code" : "...",
  "parentEntity" : {
    "parentEntityType" : { },
    "code" : "...",
    "parentEntity" : { },
    "description" : "...",
    "appendGeneratedCode" : true,
    "descriptionOrCode" : "...",
    "active" : true,
    "disabled" : true,
    "auditable" : {
      "lastModified" : 12345,
      "updater" : "...",
      "created" : 12345,
      "updated" : 12345,
      "creator" : "...",
      "lastUser" : "..."
    },
    "id" : 12345,
    "transient" : true,
    "version" : 12345
  },
  "description" : "...",
  "appendGeneratedCode" : true,
  "descriptionOrCode" : "...",
  "active" : true,
  "disabled" : true,
  "auditable" : {
    "lastModified" : 12345,
    "updater" : "...",
    "created" : 12345,
    "updated" : 12345,
    "creator" : "...",
    "lastUser" : "..."
  },
  "id" : 12345,
  "transient" : true,
  "version" : 12345
}