Create or update an array of product offerings
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferings
Request
There are no request parameters for this operation.
- application/json
array
1
50
-
Array of:
ProductOfferingOracle
Title:
ProductOfferingOracle
ProductOfferingOracle
-
object
ProductOffering
Title:
ProductOffering
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductOffering":"#/components/schemas/ProductOffering", "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle" } }
-
object
type
object
ProductOffering
Discriminator Values
Show Source-
@baseType: string
Immediate base (class) type of the product offering
-
@schemaLocation: string
A link to the schema describing this product offering
-
@type(required): string
Class type of the product offering
-
agreement: array
agreement
-
attachment: array
attachment
-
bundledGroupProductOffering: array
bundledGroupProductOffering
A BundledGroupProductOffering. A group of ProductOfferings that can be selected for instantiation, e.g. between 2 and 7 from a list of 15 channel packs.
-
bundledProductOffering: array
bundledProductOffering
-
category: array
category
-
channel: array
channel
-
description: string
Description of the productOffering
-
href: string
Reference of the ProductOffering
-
id: string
Maximum Length:
30
Unique identifier of the productOffering -
isBundle: boolean
isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).
-
isSellable: boolean
A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle.
-
lastUpdate: string
(date-time)
Date and time of the last update
-
lifecycleStatus: string
Used to indicate the current lifecycle status
-
marketSegment: array
marketSegment
-
name: string
Name of the productOffering
-
place: array
place
-
prodSpecCharValueUse: array
prodSpecCharValueUse
-
productOfferingPrice: array
productOfferingPrice
-
productOfferingTerm: array
productOfferingTerm
-
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
resourceCandidate: object
ResourceCandidateRef
Title:
ResourceCandidateRef
ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog. -
serviceCandidate:
ServiceCandidateRefOracle
Title:
ServiceCandidateRefOracle
-
serviceLevelAgreement: object
SLARef
Title:
SLARef
ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service. -
specCharValueUse: array
specCharValueUse
-
statusReason: string
Used to indicate the current status reason
-
subStatus: string
sub status code
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
ProductOffering version
object
-
applicationName: string
name of the external application
-
approvalHistory: array
approvalHistory
-
approvalInfo: object
ApprovalInfoOracle
Title:
ApprovalInfoOracle
-
approver: array
approver
-
banner: array
banner
-
businessUnitId: number
Indicates Business Unit to which the offer belongs.
-
businessUnitName: string
Indicates name of Business Unit to which the offer belongs.
-
choiceRelationship:
ChoiceRelationshipOracle
Title:
ChoiceRelationshipOracle
Denotes the choice bundle which is overriden by this bundle -
commercialName: string
Commercial name of Product Offering
-
created: string
(date-time)
Date and time of the creation
-
createdBy: string
name of the person who created item
-
customProfileSpec: array
customProfileSpec
-
customProfSpecCharValueUse: array
customProfSpecCharValueUse
-
externalId: string
id of the external application
-
isDynamic: boolean
Indicates if it is a dynamic Option Group
-
lastUpdatedBy: string
name of the person who updated item
-
marketingFeature: array
marketingFeature
-
pricelist: array
pricelist
-
pricePlanRelationship: array
pricePlanRelationship
-
productLine: array
productLine
-
productOfferingCharacteristic: array
productOfferingCharacteristic
-
productOfferingInfo(required): object
ProductOfferingInfoOracle
Title:
ProductOfferingInfoOracle
More information on the Product Offering -
productOfferingRelationship: array
productOfferingRelationship
-
project: object
ProjectRef
Title:
ProjectRef
Project Reference -
searchTag: array
searchTag
-
usedBy: array
usedBy
Read Only:
true
-
versionState: number
Version state of the productOffering
array
-
Array of:
object ApprovalHistory
Title:
ApprovalHistory
object
ApprovalInfoOracle
-
approvalFor: string
A string. approval for.
-
comments: string
A string. A narrative that explains in detail what the approval history is.
-
entityName: string
Maximum Length:
100
A string. Entity name. -
id: string
Maximum Length:
100
A string. Unique identifier of the approval info. -
requestedOn: string
(date-time)
A date time (DateTime). Date and time of the approval.
-
requestor(required): string
A string. requestor.
array
-
Array of:
object ApproverRef
Title:
ApproverRef
Approver Reference
ChoiceRelationshipOracle
-
object
ProductOfferingRef
Title:
ProductOfferingRef
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information. -
object
ChoiceRelationshipOracle-allOf[1]
array
-
Array of:
object CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference.
array
-
Array of:
object CustomProfSpecCharValueUse
Title:
CustomProfSpecCharValueUse
A use of the CustomProfSpecCharValue by an entity to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
array
-
Array of:
object FeatureOracle
Title:
FeatureOracle
array
-
Array of:
object PriceListRefOracle
Title:
PriceListRefOracle
Pricelist reference.
array
-
Array of:
PricePlanRelationshipOracle
Title:
PricePlanRelationshipOracle
Relationship between a PricePlan and its price relationships in the context of an offer
array
-
Array of:
object ProductLineRef
Title:
ProductLineRef
Product Line Reference
array
-
Array of:
ProductOfferCharacteristicOracle
Title:
ProductOfferCharacteristicOracle
The ProductSpecCharacteristic addressed by this object must exist in the corresponding product specification and has to be non configurable or overridden as non configurable at the ProductOffering level.
object
ProductOfferingInfoOracle
-
allowBYOD: boolean
A flag indicating whether product offering allows you to bring your own device or not.
-
allowManualOverride: boolean
A flag indicating whether product offering allows you for manual override.
-
billingServiceType: string
Used to indicate billing service type.
-
billingType: string
Allowed Values:
[ "SUBSCRIPTION", "ITEM", "SPECIAL_RATING", "SERVICE_BUNDLE" ]
Used to indicate a billing of product. -
checkEligibility: boolean
A flag indicating whether to check eligibility of product or not.
-
compositionType: string
Allowed Values:
[ "PARTIAL_ITEM", "WHOLE_ITEM" ]
Used to indicate composition type of product. The default value is WHOLE_ITEM. -
dynamicDiscountMethod: string
Allowed Values:
[ "AMOUNT", "PERCENTAGE" ]
This code specifies whether the discount override is amount or percentage. -
fulfillmentItemCode: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
installationRequired: boolean
A flag indicating whether installation is required for product offering.
-
isBillable: boolean
A flag indicating if the product is billable or not.
-
isConfigurable: boolean
If true, the Boolean indicates that is configurable
-
isEligibleForSelfService: boolean
Indicates if the Product Offering is eligible for self service
-
isEligibleForService: boolean
Indicates if the Product Offering is eligible for Service
-
isShippable: boolean
A flag indicating whether product is shippable or not.
-
maximumPriceOverrideLimit: number
Maximum price override limit.
-
overrideDefaultDiscount: boolean
A flag indicating whether default discount can be overridden at run time.
-
pricingCommitType: string
Allowed Values:
[ "COMMITTED", "DYNAMIC" ]
The code is used to denote price override type. -
productType(required): string
Allowed Values:
[ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "TIME_BASED_OFFER", "SYSTEM_OFFER", "SYSTEM_DISCOUNT" ]
Used to indicate the type of product. -
returnIfDefective: boolean
A flag indicating whether product can be returned If Defective.
-
serviceInstance: boolean
A flag indicating a subscription product as a simple service bundle.
-
specialRatingMaxItems: integer
indicates the maxItems for special rating
-
specialRatingType: string
Allowed Values:
[ "PHONE_NUMBER" ]
Indicates the type of special rating -
trackAsAsset: boolean
When the product is purchased, you want to track it as a customer asset to allows you to create quotes and orders based on the asset.
array
-
Array of:
object ProductOfferingRelationship
Title:
ProductOfferingRelationship
Relationship between/among product offerings.
object
ProjectRef
-
href: string
Unique reference of the project
-
id(required): string
Unique identifier of the project
-
name: string
Name of the project
-
version: string
Version of the project
array
true
-
Array of:
object UsedByRef
Title:
UsedByRef
A reference to a resource that is aggregating another top-level resource.
object
ApprovalHistory
-
approvalAction: string
A string. approval action.
-
approvalDate: string
(date-time)
A date time (DateTime). Date and time of the approval.
-
approvalFor: string
A string. approval for.
-
approver: string
A string. approver.
-
comments: string
A string. A narrative that explains in detail what the approval history is.
-
entityName: string
Maximum Length:
100
A string. Entity name. -
id(required): string
Maximum Length:
100
A string. Unique identifier of the approval history. -
projectId: string
Maximum Length:
100
A string. Unique identifier of the project id. -
projectName: string
Maximum Length:
100
A string. Project Name. -
requestor: string
A string. requestor.
object
ApproverRef
-
id(required): string
UserId of the approver
-
name: string
Name of the approver
object
BannerOracle
-
description: string
description of the banner.
-
name(required): string
name of the banner.
-
priority: number
priority of this banner for the productOffering it is associated with
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party
object
TimePeriodOracle
-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
object
ProductOfferingRef
Discriminator Values
- ProductOfferingRef
- BundledProductOffering
- BundledProductOfferingChoiceOracle
- BundledProductOfferingOracle
-
@baseType: string
base class type (immediate parent) of the ProductOfferingRef
-
@referredType(required): string
the class type of the referred product offering
-
@schemaLocation: string
Hyperlink reference to schema describing this object
-
@type(required): string
The class type of this ProductOfferingRef
-
href: string
Reference of the product offering
-
id(required): string
Unique identifier of the product offering
-
name: string
Name of the product offering
-
version: string
Version of the product offering
-
versionState: number
To hold the version state for the reference
object
-
parentBundle: object
ProductOfferingRef
Title:
ProductOfferingRef
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
object
CustomProfileSpecRefOracle
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
(Class) type of the referred custom Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of customSpecificationRef.
-
href: string
Reference of the custom specification.
-
id(required): string
Unique identifier of the custom specification.
-
name: string
Name of the custom specification.
-
version: string
Version of the custom specification.
-
versionState: number
To hold the version state for the reference
object
CustomProfSpecCharValueUse
-
customProfileSpec(required): object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
customProfileSpecCharValue(required): array
customProfileSpecCharValue
-
description: string
A narrative that explains in detail what the customProfileSpecCharacteristic is
-
maxCardinality: integer
The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.
-
minCardinality: integer
The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.
-
name(required): string
Name of the associated customProfileSpecCharacteristic
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party -
valueType: string
Allowed Values:
[ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME" ]
A kind of value that the characteristic can take on, such as numeric, text and so forth
array
-
Array of:
object CustomProfileSpecCharValue
Title:
CustomProfileSpecCharValue
A number or text that can be assigned to a CustomProfileSpecCharacteristic.
object
CustomProfileSpecCharValue
-
@baseType: string
base class type (immediate parent) of the ProductSpecCharacteristic
-
@schemaLocation: string
Hyperlink reference to schema describing this object
-
@type(required): string
The class type of the characteristic value
-
displayText: string
A string. A word, term, or phrase by which can be displyed for user experience.
-
enabled: boolean
A field which used to enable or disable the value selection
-
isDefault: boolean
Indicates if the value is the default value for a characteristic
-
rangeInterval: string
Allowed Values:
[ "OPEN", "CLOSED", "CLOSED_BOTTOM", "CLOSED_TOP" ]
An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop". -
regex: string
Regular expression to define constraint on the allowed value
-
sequence: integer
Order sequence for the values input
-
unitOfMeasure: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
Could be minutes, GB... -
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party -
value(required):
value
A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
-
valueFrom: string
The low range value that a characteristic can take on
-
valueReferenceId: string
Id of the resource referenced in the specification
-
valueReferenceType: string
Allowed Values:
[ "SERVICE_SPEC" ]
Type of the resource referenced in the specification -
valueTo: string
The upper range value that a characteristic can take on
-
valueType: string
Allowed Values:
[ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME", "PRODUCT_OFFER", "PRODUCT_SPEC", "PRODUCT_LINE" ]
A kind of value that the characteristic can take on, such as numeric, text, and so forth
object
array
object
FeatureOracle
-
blurb: string
description of the feature
-
description: string
description of the feature
-
name(required): string
name of the feature
-
rank: integer
Numeric ranking of a marketing feature
-
url: string
Reference of the image url.
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid
object
TimePeriod
-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
object
PriceListRefOracle
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
The Class type of referred Price List
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of PricelistRef.
-
href: string
Unique reference of the Pricelist
-
id(required): string
Unique identifier of the Pricelist
-
name: string
Name of the Pricelist
-
productOfferingPrice: array
productOfferingPrice
-
productOfferingTerm: array
productOfferingTerm
-
version: string
Version of the Pricelist
array
-
Array of:
object ProductOfferingPriceRef
Title:
ProductOfferingPriceRef
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
array
-
Array of:
object TermSummary
Title:
TermSummary
Term Summary Oracle
object
ProductOfferingPriceRef
-
@baseType: string
When sub-classing, this defines the super-class
-
@referredType(required): string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
When sub-classing, this defines the sub-class entity name
-
href: string
Reference of the related entity.
-
id(required): string
Unique identifier of a related entity.
-
name: string
Name of the related entity.
-
refId: string
Unique identifier of the reference object.
-
refName: string
Name of the reference object.
-
version: string
version of a related entity.
-
versionState: number
To hold the version state of reference
object
TermSummary
-
@baseType: string
base class type (immediate parent) of the ProductOfferintTerm.
-
@type(required): string
the class type of term
-
commitmentTermType: string
Allowed Values:
[ "INSTALLMENT", "LEASE", "SERVICE" ]
-
duration:
TermDuration
Title:
TermDuration
-
name: string
A string. A word, term, or phrase by which a term is identfied
TermDuration
-
object
Quantity
Title:
Quantity
A number and unit representing how many of an ProductOffering is available at the offered price. -
object
TermDuration-allOf[1]
object
Quantity
-
amount(required): number
A quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
-
units(required): string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
The unit of measure for the quantity, such as meters, cubic yards, kilograms [ISO 80000], and the currency referring to [ISO 4217].
object
-
units: string
Allowed Values:
[ "DAYS", "MONTHS", "WEEKS", "YEARS" ]
Term duration units
PricePlanRelationshipOracle
-
object
ProductOfferingPriceRef
Title:
ProductOfferingPriceRef
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased -
object
PricePlanRelationshipOracle-allOf[1]
object
-
applicableProductOffering: array
applicableProductOffering
-
appliesTo: string
Allowed Values:
[ "ALL", "ONE_TIME", "RECURRING", "USAGE" ]
Bring in a open ended definition of alteration that specifies how price plan applicable to the offer -
popRelationship: array
popRelationship
-
version: string
Version of the PricePlanRelationship being referred
array
-
Array of:
ApplicableProductOfferingOracle
Title:
ApplicableProductOfferingOracle
array
-
Array of:
ProductOfferingPriceRelationshipOracle
Title:
ProductOfferingPriceRelationshipOracle
this object represents a pop relationship
ApplicableProductOfferingOracle
-
object
ProductOfferingRef
Title:
ProductOfferingRef
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information. -
object
ApplicableProductOfferingOracle-allOf[1]
object
-
relationshipHierarchy: string
Hierarchy of the bundle offer tree
-
version: string
Version of the referred offering
ProductOfferingPriceRelationshipOracle
-
object
ProductOfferingPriceRelationship
Title:
ProductOfferingPriceRelationship
this object represents a pop relationship -
object
ProductOfferingPriceRelationshipOracle-allOf[1]
object
ProductOfferingPriceRelationship
-
@baseType: string
When sub-classing, this defines the super-class
-
@referredType(required): string
The (class) type of the referred ProductOfferingPriceRelationship
-
@schemaLocation: string
(uri)
This field provides a link to the schema describing this REST resource
-
@type(required): string
(Class) type of the associated ProductOfferingPriceRelationship
-
href: string
hyperlink reference of the associated ProductOfferingPriceRelationship
-
id(required): string
Unique identifier of ProductOfferingPriceRelationship
-
name: string
Name of the associated ProductOfferingPriceRelationship
-
relationshipType(required): string
Allowed Values:
[ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE", "DEPENDENCY" ]
POP relationship type -
version: string
Version of the associated popRelationship
-
versionState: number
To hold the version state of reference
object
-
sequential: boolean
Indicates whether the price is applied sequential or not
-
version: string
Version of the price being refered.
object
ProductLineRef
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
class type of referred Product Line
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of Product Line.
-
href: string
Unique reference of the product line
-
id(required): string
Unique identifier of the product line
-
name: string
Name of the product line
-
version: string
Version of the product Line
-
versionState: number
To hold the version state of reference
ProductOfferCharacteristicOracle
-
object
CharacteristicSpecification
Title:
CharacteristicSpecification
Discriminator:{ "propertyName":"@type", "mapping":{ "CharacteristicSpecification":"#/components/schemas/CharacteristicSpecification", "CharacteristicSpecificationOracle":"#/components/schemas/CharacteristicSpecificationOracle", "ProductOfferCharacteristicOracle":"#/components/schemas/ProductOfferCharacteristicOracle" } }
A characteristic quality or distinctive feature of a PlaSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process. -
object
ProductOfferCharacteristicOracle-allOf[1]
object
CharacteristicSpecification
Discriminator Values
-
@baseType: string
base class type (immediate parent) of the ProductSpecCharacteristic
-
@schemaLocation: string
hyperlink reference to the schema describing this characteristic
-
@type(required): string
the class type of this characteristic
-
@valueSchemaLocation: string
This (optional) field provides a link to the schema describing the value type.
-
allowedUnits: array
allowedUnits
-
characteristicValueSpecification: array
characteristicValueSpecification
-
charSpecRelationship: array
charSpecRelationship
-
configurable: boolean
If true, the Boolean indicates that the productSpecCharacteristic is configurable
-
description: string
A narrative that explains in detail what the productSpecCharacteristic is
-
extensible: boolean
An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product
-
id: string
Maximum Length:
30
Unique identifier of the attribute -
isUnique: boolean
An indicator that specifies if a value is unique for the specification. Possible values are; "unique while value is in effect" and "unique whether value is in effect or not"
-
maxCardinality: integer
The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality
-
minCardinality: integer
The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality
-
name(required): string
Name of the productSpecCharacteristic
-
regex: string
A rule or principle represented in regular expression used to derive the value of a characteristic value
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party -
valueType: string
Allowed Values:
[ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME", "URL" ]
A kind of value that the characteristic can take on, such as numeric, text and so forth
object
-
configurable: boolean
Read only value, if true, the Boolean indicates that the productSpecCharacteristic is configurable
-
description: string
A narrative that explains in detail what the productSpecCharacteristic is
-
displayName: string
Friendly name of the associated productSpecCharacteristic
-
name: string
Name of the associated productSpecCharacteristic
-
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
valueType: string
A kind of value that the characteristic can take on, such as numeric, text and so forth
object
ProductSpecificationRef
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
class type of referred Product Specification
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of ProductSpecificationRef.
-
href: string
Reference of the product specification
-
id(required): string
Unique identifier of the product specification
-
name: string
Name of the product specification
-
targetProductSchema: object
TargetProductSchema
Title:
TargetProductSchema
The reference object to the schema and type of target product which is described by product specification -
version: string
Version of the product specification
-
versionState: number
To hold the version state for the reference
object
TargetProductSchema
-
@schemaLocation(required): string
This field provides a link to the schema describing the target product
-
@type(required): string
class type of the target product
object
ProductOfferingRelationship
-
@baseType: string
When sub-classing, this defines the super-class
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name
-
id(required): string
Unique identifier of the productOffering
-
name: string
Name of the referred product productOffering
-
relationshipType: string
Allowed Values:
[ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY", "PARENT" ]
Type of the relationship such as migration, substitution, dependency, exclusivity -
role: string
Role of the product productOffering relationship
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party
object
UsedByRef
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType: string
The Class type of using item
-
href: string
hyperlink reference of the using item
-
id: string
Unique identifier of the using item
-
name: string
Name of the using item
-
referenceType: string
Allowed Values:
[ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "AWARD", "DISCOUNT", "TRADE_IN", "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "POLICY", "DEVICE_SPEC", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "PRODUCT_LINE", "PRODUCT_OFFERING_PRICE", "CATALOG", "CATEGORY", "PRODUCT_SPECIFICATION", "USAGE_SPECIFICATION", "SERVICE_SPECIFICATION" ]
The entity type of using item -
version: string
Version of the using item
Response
- application/json
200 Response
array
-
Array of:
ProductOfferingOracle
Title:
ProductOfferingOracle
ProductOfferingOracle
-
object
ProductOffering
Title:
ProductOffering
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductOffering":"#/components/schemas/ProductOffering", "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle" } }
-
object
type
object
ProductOffering
Discriminator Values
Show Source-
@baseType: string
Immediate base (class) type of the product offering
-
@schemaLocation: string
A link to the schema describing this product offering
-
@type(required): string
Class type of the product offering
-
agreement: array
agreement
-
attachment: array
attachment
-
bundledGroupProductOffering: array
bundledGroupProductOffering
A BundledGroupProductOffering. A group of ProductOfferings that can be selected for instantiation, e.g. between 2 and 7 from a list of 15 channel packs.
-
bundledProductOffering: array
bundledProductOffering
-
category: array
category
-
channel: array
channel
-
description: string
Description of the productOffering
-
href: string
Reference of the ProductOffering
-
id: string
Maximum Length:
30
Unique identifier of the productOffering -
isBundle: boolean
isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true).
-
isSellable: boolean
A flag indicating if this product offer can be sold stand-alone for sale or not. If this flag is false it indicates that the offer can only be sold within a bundle.
-
lastUpdate: string
(date-time)
Date and time of the last update
-
lifecycleStatus: string
Used to indicate the current lifecycle status
-
marketSegment: array
marketSegment
-
name: string
Name of the productOffering
-
place: array
place
-
prodSpecCharValueUse: array
prodSpecCharValueUse
-
productOfferingPrice: array
productOfferingPrice
-
productOfferingTerm: array
productOfferingTerm
-
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
resourceCandidate: object
ResourceCandidateRef
Title:
ResourceCandidateRef
ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog. -
serviceCandidate:
ServiceCandidateRefOracle
Title:
ServiceCandidateRefOracle
-
serviceLevelAgreement: object
SLARef
Title:
SLARef
ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service. -
specCharValueUse: array
specCharValueUse
-
statusReason: string
Used to indicate the current status reason
-
subStatus: string
sub status code
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
ProductOffering version
object
-
applicationName: string
name of the external application
-
approvalHistory: array
approvalHistory
-
approvalInfo: object
ApprovalInfoOracle
Title:
ApprovalInfoOracle
-
approver: array
approver
-
banner: array
banner
-
businessUnitId: number
Indicates Business Unit to which the offer belongs.
-
businessUnitName: string
Indicates name of Business Unit to which the offer belongs.
-
choiceRelationship:
ChoiceRelationshipOracle
Title:
ChoiceRelationshipOracle
Denotes the choice bundle which is overriden by this bundle -
commercialName: string
Commercial name of Product Offering
-
created: string
(date-time)
Date and time of the creation
-
createdBy: string
name of the person who created item
-
customProfileSpec: array
customProfileSpec
-
customProfSpecCharValueUse: array
customProfSpecCharValueUse
-
externalId: string
id of the external application
-
isDynamic: boolean
Indicates if it is a dynamic Option Group
-
lastUpdatedBy: string
name of the person who updated item
-
marketingFeature: array
marketingFeature
-
pricelist: array
pricelist
-
pricePlanRelationship: array
pricePlanRelationship
-
productLine: array
productLine
-
productOfferingCharacteristic: array
productOfferingCharacteristic
-
productOfferingInfo(required): object
ProductOfferingInfoOracle
Title:
ProductOfferingInfoOracle
More information on the Product Offering -
productOfferingRelationship: array
productOfferingRelationship
-
project: object
ProjectRef
Title:
ProjectRef
Project Reference -
searchTag: array
searchTag
-
usedBy: array
usedBy
Read Only:
true
-
versionState: number
Version state of the productOffering
array
-
Array of:
object ApprovalHistory
Title:
ApprovalHistory
object
ApprovalInfoOracle
-
approvalFor: string
A string. approval for.
-
comments: string
A string. A narrative that explains in detail what the approval history is.
-
entityName: string
Maximum Length:
100
A string. Entity name. -
id: string
Maximum Length:
100
A string. Unique identifier of the approval info. -
requestedOn: string
(date-time)
A date time (DateTime). Date and time of the approval.
-
requestor(required): string
A string. requestor.
array
-
Array of:
object ApproverRef
Title:
ApproverRef
Approver Reference
ChoiceRelationshipOracle
-
object
ProductOfferingRef
Title:
ProductOfferingRef
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information. -
object
ChoiceRelationshipOracle-allOf[1]
array
-
Array of:
object CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference.
array
-
Array of:
object CustomProfSpecCharValueUse
Title:
CustomProfSpecCharValueUse
A use of the CustomProfSpecCharValue by an entity to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
array
-
Array of:
object FeatureOracle
Title:
FeatureOracle
array
-
Array of:
object PriceListRefOracle
Title:
PriceListRefOracle
Pricelist reference.
array
-
Array of:
PricePlanRelationshipOracle
Title:
PricePlanRelationshipOracle
Relationship between a PricePlan and its price relationships in the context of an offer
array
-
Array of:
object ProductLineRef
Title:
ProductLineRef
Product Line Reference
array
-
Array of:
ProductOfferCharacteristicOracle
Title:
ProductOfferCharacteristicOracle
The ProductSpecCharacteristic addressed by this object must exist in the corresponding product specification and has to be non configurable or overridden as non configurable at the ProductOffering level.
object
ProductOfferingInfoOracle
-
allowBYOD: boolean
A flag indicating whether product offering allows you to bring your own device or not.
-
allowManualOverride: boolean
A flag indicating whether product offering allows you for manual override.
-
billingServiceType: string
Used to indicate billing service type.
-
billingType: string
Allowed Values:
[ "SUBSCRIPTION", "ITEM", "SPECIAL_RATING", "SERVICE_BUNDLE" ]
Used to indicate a billing of product. -
checkEligibility: boolean
A flag indicating whether to check eligibility of product or not.
-
compositionType: string
Allowed Values:
[ "PARTIAL_ITEM", "WHOLE_ITEM" ]
Used to indicate composition type of product. The default value is WHOLE_ITEM. -
dynamicDiscountMethod: string
Allowed Values:
[ "AMOUNT", "PERCENTAGE" ]
This code specifies whether the discount override is amount or percentage. -
fulfillmentItemCode: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
installationRequired: boolean
A flag indicating whether installation is required for product offering.
-
isBillable: boolean
A flag indicating if the product is billable or not.
-
isConfigurable: boolean
If true, the Boolean indicates that is configurable
-
isEligibleForSelfService: boolean
Indicates if the Product Offering is eligible for self service
-
isEligibleForService: boolean
Indicates if the Product Offering is eligible for Service
-
isShippable: boolean
A flag indicating whether product is shippable or not.
-
maximumPriceOverrideLimit: number
Maximum price override limit.
-
overrideDefaultDiscount: boolean
A flag indicating whether default discount can be overridden at run time.
-
pricingCommitType: string
Allowed Values:
[ "COMMITTED", "DYNAMIC" ]
The code is used to denote price override type. -
productType(required): string
Allowed Values:
[ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "TIME_BASED_OFFER", "SYSTEM_OFFER", "SYSTEM_DISCOUNT" ]
Used to indicate the type of product. -
returnIfDefective: boolean
A flag indicating whether product can be returned If Defective.
-
serviceInstance: boolean
A flag indicating a subscription product as a simple service bundle.
-
specialRatingMaxItems: integer
indicates the maxItems for special rating
-
specialRatingType: string
Allowed Values:
[ "PHONE_NUMBER" ]
Indicates the type of special rating -
trackAsAsset: boolean
When the product is purchased, you want to track it as a customer asset to allows you to create quotes and orders based on the asset.
array
-
Array of:
object ProductOfferingRelationship
Title:
ProductOfferingRelationship
Relationship between/among product offerings.
object
ProjectRef
-
href: string
Unique reference of the project
-
id(required): string
Unique identifier of the project
-
name: string
Name of the project
-
version: string
Version of the project
array
true
-
Array of:
object UsedByRef
Title:
UsedByRef
A reference to a resource that is aggregating another top-level resource.
object
ApprovalHistory
-
approvalAction: string
A string. approval action.
-
approvalDate: string
(date-time)
A date time (DateTime). Date and time of the approval.
-
approvalFor: string
A string. approval for.
-
approver: string
A string. approver.
-
comments: string
A string. A narrative that explains in detail what the approval history is.
-
entityName: string
Maximum Length:
100
A string. Entity name. -
id(required): string
Maximum Length:
100
A string. Unique identifier of the approval history. -
projectId: string
Maximum Length:
100
A string. Unique identifier of the project id. -
projectName: string
Maximum Length:
100
A string. Project Name. -
requestor: string
A string. requestor.
object
ApproverRef
-
id(required): string
UserId of the approver
-
name: string
Name of the approver
object
BannerOracle
-
description: string
description of the banner.
-
name(required): string
name of the banner.
-
priority: number
priority of this banner for the productOffering it is associated with
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party
object
TimePeriodOracle
-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
object
ProductOfferingRef
Discriminator Values
- ProductOfferingRef
- BundledProductOffering
- BundledProductOfferingChoiceOracle
- BundledProductOfferingOracle
-
@baseType: string
base class type (immediate parent) of the ProductOfferingRef
-
@referredType(required): string
the class type of the referred product offering
-
@schemaLocation: string
Hyperlink reference to schema describing this object
-
@type(required): string
The class type of this ProductOfferingRef
-
href: string
Reference of the product offering
-
id(required): string
Unique identifier of the product offering
-
name: string
Name of the product offering
-
version: string
Version of the product offering
-
versionState: number
To hold the version state for the reference
object
-
parentBundle: object
ProductOfferingRef
Title:
ProductOfferingRef
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
object
CustomProfileSpecRefOracle
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
(Class) type of the referred custom Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of customSpecificationRef.
-
href: string
Reference of the custom specification.
-
id(required): string
Unique identifier of the custom specification.
-
name: string
Name of the custom specification.
-
version: string
Version of the custom specification.
-
versionState: number
To hold the version state for the reference
object
CustomProfSpecCharValueUse
-
customProfileSpec(required): object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
customProfileSpecCharValue(required): array
customProfileSpecCharValue
-
description: string
A narrative that explains in detail what the customProfileSpecCharacteristic is
-
maxCardinality: integer
The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.
-
minCardinality: integer
The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.
-
name(required): string
Name of the associated customProfileSpecCharacteristic
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party -
valueType: string
Allowed Values:
[ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME" ]
A kind of value that the characteristic can take on, such as numeric, text and so forth
array
-
Array of:
object CustomProfileSpecCharValue
Title:
CustomProfileSpecCharValue
A number or text that can be assigned to a CustomProfileSpecCharacteristic.
object
CustomProfileSpecCharValue
-
@baseType: string
base class type (immediate parent) of the ProductSpecCharacteristic
-
@schemaLocation: string
Hyperlink reference to schema describing this object
-
@type(required): string
The class type of the characteristic value
-
displayText: string
A string. A word, term, or phrase by which can be displyed for user experience.
-
enabled: boolean
A field which used to enable or disable the value selection
-
isDefault: boolean
Indicates if the value is the default value for a characteristic
-
rangeInterval: string
Allowed Values:
[ "OPEN", "CLOSED", "CLOSED_BOTTOM", "CLOSED_TOP" ]
An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop". -
regex: string
Regular expression to define constraint on the allowed value
-
sequence: integer
Order sequence for the values input
-
unitOfMeasure: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
Could be minutes, GB... -
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party -
value(required):
value
A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
-
valueFrom: string
The low range value that a characteristic can take on
-
valueReferenceId: string
Id of the resource referenced in the specification
-
valueReferenceType: string
Allowed Values:
[ "SERVICE_SPEC" ]
Type of the resource referenced in the specification -
valueTo: string
The upper range value that a characteristic can take on
-
valueType: string
Allowed Values:
[ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME", "PRODUCT_OFFER", "PRODUCT_SPEC", "PRODUCT_LINE" ]
A kind of value that the characteristic can take on, such as numeric, text, and so forth
object
array
object
FeatureOracle
-
blurb: string
description of the feature
-
description: string
description of the feature
-
name(required): string
name of the feature
-
rank: integer
Numeric ranking of a marketing feature
-
url: string
Reference of the image url.
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid
object
TimePeriod
-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
object
PriceListRefOracle
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
The Class type of referred Price List
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of PricelistRef.
-
href: string
Unique reference of the Pricelist
-
id(required): string
Unique identifier of the Pricelist
-
name: string
Name of the Pricelist
-
productOfferingPrice: array
productOfferingPrice
-
productOfferingTerm: array
productOfferingTerm
-
version: string
Version of the Pricelist
array
-
Array of:
object ProductOfferingPriceRef
Title:
ProductOfferingPriceRef
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
array
-
Array of:
object TermSummary
Title:
TermSummary
Term Summary Oracle
object
ProductOfferingPriceRef
-
@baseType: string
When sub-classing, this defines the super-class
-
@referredType(required): string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
When sub-classing, this defines the sub-class entity name
-
href: string
Reference of the related entity.
-
id(required): string
Unique identifier of a related entity.
-
name: string
Name of the related entity.
-
refId: string
Unique identifier of the reference object.
-
refName: string
Name of the reference object.
-
version: string
version of a related entity.
-
versionState: number
To hold the version state of reference
object
TermSummary
-
@baseType: string
base class type (immediate parent) of the ProductOfferintTerm.
-
@type(required): string
the class type of term
-
commitmentTermType: string
Allowed Values:
[ "INSTALLMENT", "LEASE", "SERVICE" ]
-
duration:
TermDuration
Title:
TermDuration
-
name: string
A string. A word, term, or phrase by which a term is identfied
TermDuration
-
object
Quantity
Title:
Quantity
A number and unit representing how many of an ProductOffering is available at the offered price. -
object
TermDuration-allOf[1]
object
Quantity
-
amount(required): number
A quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
-
units(required): string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
The unit of measure for the quantity, such as meters, cubic yards, kilograms [ISO 80000], and the currency referring to [ISO 4217].
object
-
units: string
Allowed Values:
[ "DAYS", "MONTHS", "WEEKS", "YEARS" ]
Term duration units
PricePlanRelationshipOracle
-
object
ProductOfferingPriceRef
Title:
ProductOfferingPriceRef
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased -
object
PricePlanRelationshipOracle-allOf[1]
object
-
applicableProductOffering: array
applicableProductOffering
-
appliesTo: string
Allowed Values:
[ "ALL", "ONE_TIME", "RECURRING", "USAGE" ]
Bring in a open ended definition of alteration that specifies how price plan applicable to the offer -
popRelationship: array
popRelationship
-
version: string
Version of the PricePlanRelationship being referred
array
-
Array of:
ApplicableProductOfferingOracle
Title:
ApplicableProductOfferingOracle
array
-
Array of:
ProductOfferingPriceRelationshipOracle
Title:
ProductOfferingPriceRelationshipOracle
this object represents a pop relationship
ApplicableProductOfferingOracle
-
object
ProductOfferingRef
Title:
ProductOfferingRef
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information. -
object
ApplicableProductOfferingOracle-allOf[1]
object
-
relationshipHierarchy: string
Hierarchy of the bundle offer tree
-
version: string
Version of the referred offering
ProductOfferingPriceRelationshipOracle
-
object
ProductOfferingPriceRelationship
Title:
ProductOfferingPriceRelationship
this object represents a pop relationship -
object
ProductOfferingPriceRelationshipOracle-allOf[1]
object
ProductOfferingPriceRelationship
-
@baseType: string
When sub-classing, this defines the super-class
-
@referredType(required): string
The (class) type of the referred ProductOfferingPriceRelationship
-
@schemaLocation: string
(uri)
This field provides a link to the schema describing this REST resource
-
@type(required): string
(Class) type of the associated ProductOfferingPriceRelationship
-
href: string
hyperlink reference of the associated ProductOfferingPriceRelationship
-
id(required): string
Unique identifier of ProductOfferingPriceRelationship
-
name: string
Name of the associated ProductOfferingPriceRelationship
-
relationshipType(required): string
Allowed Values:
[ "DISCOUNT", "MARKUP", "OVERRIDE", "DISCOUNT_OVERRIDE", "DEPENDENCY" ]
POP relationship type -
version: string
Version of the associated popRelationship
-
versionState: number
To hold the version state of reference
object
-
sequential: boolean
Indicates whether the price is applied sequential or not
-
version: string
Version of the price being refered.
object
ProductLineRef
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
class type of referred Product Line
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of Product Line.
-
href: string
Unique reference of the product line
-
id(required): string
Unique identifier of the product line
-
name: string
Name of the product line
-
version: string
Version of the product Line
-
versionState: number
To hold the version state of reference
ProductOfferCharacteristicOracle
-
object
CharacteristicSpecification
Title:
CharacteristicSpecification
Discriminator:{ "propertyName":"@type", "mapping":{ "CharacteristicSpecification":"#/components/schemas/CharacteristicSpecification", "CharacteristicSpecificationOracle":"#/components/schemas/CharacteristicSpecificationOracle", "ProductOfferCharacteristicOracle":"#/components/schemas/ProductOfferCharacteristicOracle" } }
A characteristic quality or distinctive feature of a PlaSpecification. The characteristic can be take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process. -
object
ProductOfferCharacteristicOracle-allOf[1]
object
CharacteristicSpecification
Discriminator Values
-
@baseType: string
base class type (immediate parent) of the ProductSpecCharacteristic
-
@schemaLocation: string
hyperlink reference to the schema describing this characteristic
-
@type(required): string
the class type of this characteristic
-
@valueSchemaLocation: string
This (optional) field provides a link to the schema describing the value type.
-
allowedUnits: array
allowedUnits
-
characteristicValueSpecification: array
characteristicValueSpecification
-
charSpecRelationship: array
charSpecRelationship
-
configurable: boolean
If true, the Boolean indicates that the productSpecCharacteristic is configurable
-
description: string
A narrative that explains in detail what the productSpecCharacteristic is
-
extensible: boolean
An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product
-
id: string
Maximum Length:
30
Unique identifier of the attribute -
isUnique: boolean
An indicator that specifies if a value is unique for the specification. Possible values are; "unique while value is in effect" and "unique whether value is in effect or not"
-
maxCardinality: integer
The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality
-
minCardinality: integer
The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality
-
name(required): string
Name of the productSpecCharacteristic
-
regex: string
A rule or principle represented in regular expression used to derive the value of a characteristic value
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party -
valueType: string
Allowed Values:
[ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME", "URL" ]
A kind of value that the characteristic can take on, such as numeric, text and so forth
object
-
configurable: boolean
Read only value, if true, the Boolean indicates that the productSpecCharacteristic is configurable
-
description: string
A narrative that explains in detail what the productSpecCharacteristic is
-
displayName: string
Friendly name of the associated productSpecCharacteristic
-
name: string
Name of the associated productSpecCharacteristic
-
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
valueType: string
A kind of value that the characteristic can take on, such as numeric, text and so forth
object
ProductSpecificationRef
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
class type of referred Product Specification
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of ProductSpecificationRef.
-
href: string
Reference of the product specification
-
id(required): string
Unique identifier of the product specification
-
name: string
Name of the product specification
-
targetProductSchema: object
TargetProductSchema
Title:
TargetProductSchema
The reference object to the schema and type of target product which is described by product specification -
version: string
Version of the product specification
-
versionState: number
To hold the version state for the reference
object
TargetProductSchema
-
@schemaLocation(required): string
This field provides a link to the schema describing the target product
-
@type(required): string
class type of the target product
object
ProductOfferingRelationship
-
@baseType: string
When sub-classing, this defines the super-class
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name
-
id(required): string
Unique identifier of the productOffering
-
name: string
Name of the referred product productOffering
-
relationshipType: string
Allowed Values:
[ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY", "PARENT" ]
Type of the relationship such as migration, substitution, dependency, exclusivity -
role: string
Role of the product productOffering relationship
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party
object
UsedByRef
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType: string
The Class type of using item
-
href: string
hyperlink reference of the using item
-
id: string
Unique identifier of the using item
-
name: string
Name of the using item
-
referenceType: string
Allowed Values:
[ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "AWARD", "DISCOUNT", "TRADE_IN", "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "POLICY", "DEVICE_SPEC", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "PRODUCT_LINE", "PRODUCT_OFFERING_PRICE", "CATALOG", "CATEGORY", "PRODUCT_SPECIFICATION", "USAGE_SPECIFICATION", "SERVICE_SPECIFICATION" ]
The entity type of using item -
version: string
Version of the using item
400 Response
array
-
Array of:
object Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }
401 Response
object
Error
-
@schemaLocation: string
it provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
404 Response
object
Error
-
@schemaLocation: string
it provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
405 Response
object
Error
-
@schemaLocation: string
it provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
500 Response
object
Error
-
@schemaLocation: string
it provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
Examples
The following example shows how to create or update an array of product offering by submitting a put request on the REST resource using cURL.
cURL Command
curl -u username:password -X PUT https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferings/ -H 'Content-Type: application/json' -D @put_productofferings.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
[ { "@type": "ProductOfferingOracle", "@baseType": "ProductOffering", "id": "DeviceOffer_001_Y2021", "name": "DeviceOffer_001_Y2021", "description": "Description of BundlePO001", "version": "1.0", "lifecycleStatus": "In design", "isBundle": false, "isSellable": true, "validFor": { "startDateTime": "2020-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" }, "productOfferingInfo": { "trackAsAsset": true, "productType": "DEVICE", "checkEligibility": false, "returnIfDefective": true }, "productSpecification": { "@referredType": "ProductSpecificationOracle", "id": "WirelessProductSpec001", "name": "WirelessProductSpec 001" }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project" }, "marketingFeature": [ { "name": "MarketSale001", "description": "description Update Patch", "rank": 3, "url": "https://www.investopedia.com/terms/m/marketshare.asp", "validFor": { "startDateTime": "2020-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" }, "blurb": "long description update" } ], "productOfferingPrice": [ { "id": "service112", "name": "service112" } ], "banner": [ { "name": "Test Banner", "priority": 1, "description": "Description of banner", "validFor": { "startDateTime": "2020-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" } } ] }, { "@type": "ProductOfferingOracle", "@baseType": "ProductOffering", "id": "ChoiceOffer_001_Y2021", "name": "ChoiceOffer_001_Y2021", "description": "Description TestTypePO013112", "version": "1.0", "lifecycleStatus": "In design", "isBundle": true, "isSellable": true, "validFor": { "startDateTime": "2020-07-13T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" }, "productOfferingInfo": { "trackAsAsset": true, "isConfigurable": false, "productType": "CHOICE" }, "productSpecification": { "@referredType": "ProductSpecificationOracle", "id": "SamsungColorSpecification", "name": "SamsungColorSpecification" }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project" }, "bundledProductOffering": [ { "id": "ProdOffer001", "name": "ProdOffer001", "@type": "BundledProductOfferingChoiceOracle", "@baseType": "BundledProductOffering", "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 } }, { "id": "ProdOffer002", "name": "ProdOffer002", "@type": "BundledProductOfferingChoiceOracle", "@baseType": "BundledProductOfferingChoiceOracle", "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 } }, { "id": "ProdOffer003", "name": "ProdOffer003", "@type": "BundledProductOfferingChoiceOracle", "@baseType": "BundledProductOfferingChoiceOracle", "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 } } ] }, { "id": "BundleOffer_001_Y2021", "name": "BundleOffer_001_Y2021", "version": "1.0", "isBundle": true, "isSellable": true, "lifecycleStatus": "In design", "validFor": { "startDateTime": "2021-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" }, "description": "Vista TyRRgdusjdpIAk", "productOfferingInfo": { "productType": "COMMERCIAL_BUNDLE", "trackAsAsset": false, "checkEligibility": true, "returnIfDefective": true }, "productSpecification": { "id": "WirelessProductSpec002", "name": "WirelessProductSpec 002", "@referredType": "ProductSpecificationOracle" }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project" }, "bundledProductOffering": [ { "id": "ProductOfferYear2021-No03", "name": "Product Offer Year2021-No03", "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 } }, { "id": "ProductOfferYear2021-No02", "name": "Product Offer Year2021-No02", "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 } }, { "id": "ProductOfferYear2021-No01", "name": "Product Offer Year2021-No01", "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 } } ], "productOfferingPrice": [ { "id": "service112", "name": "service112" } ] }, { "id": "Package_offer_001", "name": "Package_offer_001", "version": "1.0", "isBundle": true, "isSellable": true, "lifecycleStatus": "In design", "validFor": { "startDateTime": "2021-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" }, "description": "Vista TyRRgdusjdpIAk", "productOfferingInfo": { "productType": "PACKAGE", "trackAsAsset": false, "checkEligibility": true, "returnIfDefective": true }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project" }, "bundledProductOffering": [ { "id": "OfferForYear2021-No01", "name": "OfferForYear2021-No01", "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 } } ], "productOfferingPrice": [ { "id": "POP_DISCOUNT_10003", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP_DISCOUNT_10003", "name": "Hulu Discount for Supremo Unlimited" }, { "id": "PriceBundle001", "name": "PriceBundle001" } ] } ]
Example of Response Body
The following shows an example of the response body in JSON format.
[ { "id": "DeviceOffer_001_Y2021", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferings/DeviceOffer_001_Y2021", "name": "DeviceOffer_001_Y2021", "description": "Description of BundlePO001", "isBundle": false, "lifecycleStatus": "In design", "validFor": { "startDateTime": "2020-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" }, "version": "1.0", "@type": "ProductOfferingOracle", "@baseType": "ProductOffering", "isSellable": true, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject" }, "productSpecification": { "id": "WirelessProductSpec001", "name": "WirelessProductSpec 001", "version": "1.0", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/WirelessProductSpec001", "@referredType": "ProductSpecificationOracle", "@baseType": "ProductSpecificationOracle" }, "productOfferingInfo": { "trackAsAsset": true, "checkEligibility": false, "returnIfDefective": true, "productType": "DEVICE" }, "productOfferingPrice": [ { "id": "service112", "name": "service112", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/service112", "@referredType": "ProductOfferingPriceOracle", "@type": "ProductOfferingPriceRef", "@baseType": "ProductOfferingPriceOracle" } ], "banner": [ { "name": "Test Banner", "description": "Description of banner", "priority": 1, "validFor": { "startDateTime": "2020-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" } } ], "marketingFeature": [ { "name": "MarketSale001", "description": "description Update Patch", "blurb": "long description update", "url": "https://www.investopedia.com/terms/m/marketshare.asp", "rank": 3, "validFor": { "startDateTime": "2020-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" } } ] }, { "id": "ChoiceOffer_001_Y2021", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferings/ChoiceOffer_001_Y2021", "name": "ChoiceOffer_001_Y2021", "description": "Description TestTypePO013112", "isBundle": true, "lifecycleStatus": "In design", "validFor": { "startDateTime": "2020-07-13T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" }, "version": "1.0", "@type": "ProductOfferingOracle", "@baseType": "ProductOffering", "isSellable": true, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject" }, "productSpecification": { "id": "SamsungColorSpecification", "name": "SamsungColorSpecification", "version": "1.0", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/SamsungColorSpecification", "@referredType": "ProductSpecificationOracle", "@baseType": "ProductSpecificationOracle" }, "productOfferingInfo": { "trackAsAsset": true, "isConfigurable": false, "productType": "CHOICE" }, "bundledProductOffering": [ { "@referredType": "ProductOfferingOracle", "@type": "BundledProductOfferingChoiceOracle", "@baseType": "BundledProductOffering", "default": false, "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 }, "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/ProdOffer001", "name": "ProdOffer001", "id": "ProdOffer001" }, { "@referredType": "ProductOfferingOracle", "@type": "BundledProductOfferingChoiceOracle", "@baseType": "BundledProductOfferingChoiceOracle", "default": false, "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 }, "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/ProdOffer002", "name": "ProdOffer002", "id": "ProdOffer002" }, { "@referredType": "ProductOfferingOracle", "@type": "BundledProductOfferingChoiceOracle", "@baseType": "BundledProductOfferingChoiceOracle", "default": false, "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 }, "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/ProdOffer003", "name": "ProdOffer003", "id": "ProdOffer003" } ] }, { "id": "BundleOffer_001_Y2021", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferings/BundleOffer_001_Y2021", "name": "BundleOffer_001_Y2021", "description": "Vista TyRRgdusjdpIAk", "isBundle": true, "lifecycleStatus": "In design", "validFor": { "startDateTime": "2021-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" }, "version": "1.0", "@type": "ProductOfferingOracle", "isSellable": true, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject" }, "productSpecification": { "id": "WirelessProductSpec002", "name": "WirelessProductSpec 002", "version": "1.0", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/WirelessProductSpec002", "@referredType": "ProductSpecificationOracle", "@baseType": "ProductSpecificationOracle" }, "productOfferingInfo": { "trackAsAsset": false, "checkEligibility": true, "returnIfDefective": true, "productType": "COMMERCIAL_BUNDLE" }, "productOfferingPrice": [ { "id": "service112", "name": "service112", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/service112", "@referredType": "ProductOfferingPriceOracle", "@type": "ProductOfferingPriceRef", "@baseType": "ProductOfferingPriceOracle" } ], "bundledProductOffering": [ { "@referredType": "ProductOfferingOracle", "@type": "BundledProductOffering", "@baseType": "ProductOfferingOracle", "default": false, "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 }, "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/ProductOfferYear2021-No03", "name": "Product Offer Year2021-No03", "id": "ProductOfferYear2021-No03" }, { "@referredType": "ProductOfferingOracle", "@type": "BundledProductOffering", "@baseType": "ProductOfferingOracle", "default": false, "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 }, "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/ProductOfferYear2021-No02", "name": "Product Offer Year2021-No02", "id": "ProductOfferYear2021-No02" }, { "@referredType": "ProductOfferingOracle", "@type": "BundledProductOffering", "@baseType": "ProductOfferingOracle", "default": false, "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 }, "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/ProductOfferYear2021-No01", "name": "Product Offer Year2021-No01", "id": "ProductOfferYear2021-No01" } ] }, { "id": "Package_offer_001", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferings/Package_offer_001", "name": "Package_offer_001", "description": "Vista TyRRgdusjdpIAk", "isBundle": true, "lifecycleStatus": "In design", "validFor": { "startDateTime": "2021-05-02T16:42:23.0Z", "endDateTime": "2021-07-14T00:00:00.0Z" }, "version": "1.0", "@type": "ProductOfferingOracle", "isSellable": true, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject" }, "productOfferingInfo": { "trackAsAsset": false, "checkEligibility": true, "returnIfDefective": true, "productType": "PACKAGE" }, "productOfferingPrice": [ { "id": "POP_DISCOUNT_10003", "name": "Hulu Discount for Supremo Unlimited", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP_DISCOUNT_10003", "@referredType": "ProductOfferPriceAlterationOracle", "@type": "ProductOfferingPriceRef", "@baseType": "ProductOfferingPriceOracle" }, { "id": "PriceBundle001", "name": "PriceBundle001", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/PriceBundle001", "@referredType": "ProductOfferingPriceOracle", "@type": "ProductOfferingPriceRef", "@baseType": "ProductOfferingPriceOracle" } ], "bundledProductOffering": [ { "@referredType": "ProductOfferingOracle", "@type": "BundledProductOffering", "@baseType": "ProductOfferingOracle", "default": false, "bundledProductOfferingOption": { "numberRelOfferLowerLimit": 2, "numberRelOfferUpperLimit": 5, "numberRelOfferDefault": 1 }, "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/OfferForYear2021-No01", "name": "OfferForYear2021-No01", "id": "OfferForYear2021-No01" } ] }