1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Product Offerings

Update a product offering

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/{id}

Updates the product offering that matches the specified ID using the supplied request payload.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : ProductOfferingOracle
Title: ProductOfferingOracle
Match All
Show Source
  • ProductOffering
    Title: ProductOffering
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOffering":"#/components/schemas/ProductOffering", "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle" } }
    The product offering resource.
  • type
Nested Schema : ProductOffering
Type: object
Title: ProductOffering
Discriminator: @type

Discriminator Values

The product offering resource.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : approvalHistory
Type: array
A list of approval histories associated with the product offering.
Show Source
Nested Schema : ApprovalInfoOracle
Type: object
Title: ApprovalInfoOracle
The approval info resource.
Show Source
Nested Schema : approver
Type: array
A list of approvers associated with the product offering.
Show Source
Nested Schema : banner
Type: array
A list of banners associated with the product offering.
Show Source
Nested Schema : ChoiceRelationshipOracle
Title: ChoiceRelationshipOracle
Match All
Show Source
  • ProductOfferingRef
    Title: ProductOfferingRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
    The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
  • ChoiceRelationshipOracle-allOf[1]
Nested Schema : customProfileSpec
Type: array
A list of custom profile specifications associated with the product offering.
Show Source
Nested Schema : customProfSpecCharValueUse
Type: array
A list of custom prof specification characteristic value uses associated with the product offering.
Show Source
  • 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 for example 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.
Nested Schema : externalConfigurationProperties
Type: array
A list of external configuration properties associated with the product offering.
Show Source
  • ExternalConfigurationPropertiesOracle
    Title: ExternalConfigurationPropertiesOracle
    A use of the ExternalConfigurationPropertiesOracle 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 for example 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.
Nested Schema : marketingFeature
Type: array
A list of marketing features associated with the product offering.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
The custom Profile specification reference.
Show Source
Nested Schema : pricelist
Type: array
A list of pricelists associated with the product offering.
Show Source
Nested Schema : pricePlanRelationship
Type: array
A list of price plan relationships associated with the product offering.
Show Source
Nested Schema : productLine
Type: array
A list of product lines associated with the product offering.
Show Source
Nested Schema : productOfferingCharacteristic
Type: array
A list of product offering characteristics associated with the product offering.
Show Source
Nested Schema : ProductOfferingInfoOracle
Type: object
Title: ProductOfferingInfoOracle
The more information on the Product Offering.
Show Source
Nested Schema : productOfferingRelationship
Type: array
A list of product offering relationships associated with the product offering.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Nested Schema : searchTag
Type: array
A list of search tags associated with the product offering.
Show Source
Nested Schema : taxSupplier
Type: array
A list of tax suppliers associated with the product offering.
Show Source
Nested Schema : usedBy
Type: array
Read Only: true
A list of used bies associated with the product offering.
Show Source
Nested Schema : ApprovalHistory
Type: object
Title: ApprovalHistory
The approval history resource.
Show Source
Nested Schema : ApproverRef
Type: object
Title: ApproverRef
The approver reference resource.
Show Source
Nested Schema : BannerOracle
Type: object
Title: BannerOracle
The banner resource.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : ProductOfferingRef
Type: object
Title: ProductOfferingRef
Discriminator: @type

Discriminator Values

The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Show Source
Nested Schema : ChoiceRelationshipOracle-allOf[1]
Type: object
Show Source
  • ProductOfferingRef
    Title: ProductOfferingRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
    The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Nested Schema : CustomProfSpecCharValueUse
Type: object
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 for example 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.
Show Source
Nested Schema : customProfileSpecCharValue
Type: array
A list of custom profile specification characteristic values associated with the custom prof specification characteristic value use.
Show Source
Nested Schema : CustomProfileSpecCharValue
Type: object
Title: CustomProfileSpecCharValue
A number or text that can be assigned to a CustomProfileSpecCharacteristic.
Show Source
  • The base type of the custom profile specification characteristic value.
  • The URI of the schema that defines the custom profile specification characteristic value.
  • The class type of the custom profile specification characteristic value.
  • A string. A word, term, or phrase by which can be displyed for user experience.
  • Whether the custom profile specification characteristic value has enabled.
  • Whether the custom profile specification characteristic value is default.
  • 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". Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.
  • The regular expression to define constraint on the allowed value.
  • The order sequence for the values input.
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    The unit can be minutes or GB.
  • TimePeriodOracle
    Title: TimePeriodOracle
    The validity period of the related party.
  • value
    A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
  • The low range value that a characteristic can take on.
  • The ID of the value reference associated with the custom profile specification characteristic value.
  • Allowed Values: [ "SERVICE_SPEC" ]
    The type or classification of the custom profile specification characteristic value. Valid values are SERVICE_SPEC.
  • The upper range value that a characteristic can take on.
  • Allowed Values: [ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME", "PRODUCT_OFFER", "PRODUCT_SPEC", "PRODUCT_LINE", "SPEC_CHAR" ]
    The type or classification of the custom profile specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, PRODUCT_OFFER, PRODUCT_SPEC, PRODUCT_LINE, and SPEC_CHAR.
Nested Schema : value
A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Nested Schema : ExternalConfigurationPropertiesOracle
Type: object
Title: ExternalConfigurationPropertiesOracle
A use of the ExternalConfigurationPropertiesOracle 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 for example 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.
Show Source
Nested Schema : externalConfigurationValue
Type: array
A list of external configuration values associated with the external configuration property.
Show Source
Nested Schema : ExternalConfigurationValueOracle
Title: ExternalConfigurationValueOracle
Match All
Show Source
Nested Schema : FeatureOracle
Type: object
Title: FeatureOracle
The feature resource.
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid.
Show Source
Nested Schema : PriceListGroupRefOracle
Type: object
Title: PriceListGroupRefOracle
The price list group reference.
Show Source
Nested Schema : productOfferingPrice
Type: array
A list of product offering prices associated with the price list group reference.
Show Source
  • ProductOfferingPriceRef
    Title: ProductOfferingPriceRef
    The productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
Nested Schema : productOfferingTerm
Type: array
A list of product offering terms associated with the price list group reference.
Show Source
Nested Schema : ProductOfferingPriceRef
Type: object
Title: ProductOfferingPriceRef
The productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
Show Source
Nested Schema : TermSummary
Type: object
Title: TermSummary
The product offering term summary resource.
Show Source
Nested Schema : TermDuration
Title: TermDuration
Match All
Show Source
Nested Schema : Quantity
Type: object
Title: Quantity
A number and unit representing how many of an ProductOffering is available at the offered price.
Show Source
  • A quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
  • 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].
Nested Schema : TermDuration-allOf[1]
Type: object
Show Source
  • Allowed Values: [ "DAYS", "MONTHS", "WEEKS", "YEARS" ]
    The term duration units. Valid values are DAYS, MONTHS, WEEKS, and YEARS.
Nested Schema : PricePlanRelationshipOracle
Title: PricePlanRelationshipOracle
Match All
Show Source
Nested Schema : PricePlanRelationshipOracle-allOf[1]
Type: object
Show Source
Nested Schema : applicableProductOffering
Type: array
A list of applicable product offerings associated with the price plan relationship.
Show Source
Nested Schema : popRelationship
Type: array
A list of pop relationships associated with the price plan relationship.
Show Source
Nested Schema : ApplicableProductOfferingOracle
Title: ApplicableProductOfferingOracle
Match All
Show Source
  • ProductOfferingRef
    Title: ProductOfferingRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
    The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
  • ApplicableProductOfferingOracle-allOf[1]
Nested Schema : ApplicableProductOfferingOracle-allOf[1]
Type: object
Show Source
Nested Schema : ProductOfferingPriceRelationshipOracle
Title: ProductOfferingPriceRelationshipOracle
Match All
Show Source
Nested Schema : ProductOfferingPriceRelationship
Type: object
Title: ProductOfferingPriceRelationship
The product offering price relationship.
Show Source
Nested Schema : ProductOfferingPriceRelationshipOracle-allOf[1]
Type: object
Show Source
Nested Schema : ProductLineRef
Type: object
Title: ProductLineRef
The product line reference resource.
Show Source
Nested Schema : ProductOfferCharacteristicOracle
Title: ProductOfferCharacteristicOracle
Match All
Show Source
  • 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 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.
  • ProductOfferCharacteristicOracle-allOf[1]
Nested Schema : CharacteristicSpecification
Type: object
Title: CharacteristicSpecification
Discriminator: @type

Discriminator Values

A characteristic quality or distinctive feature of a PlaSpecification. The characteristic can 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.
Show Source
Nested Schema : ProductOfferCharacteristicOracle-allOf[1]
Type: object
Show Source
  • Read only value, if true, the Boolean indicates that the productSpecCharacteristic is configurable.
  • A narrative that explains in detail what the productSpecCharacteristic is.
  • The name of the display associated with the product offer characteristic.
  • The name of the product offer characteristic.
  • ProductSpecificationRef
    Title: ProductSpecificationRef
    The 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.
  • The type or classification of the product offer characteristic.
Nested Schema : ProductSpecificationRef
Type: object
Title: ProductSpecificationRef
The 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.
Show Source
Nested Schema : TargetProductSchema
Type: object
Title: TargetProductSchema
The reference object to the schema and type of target product which is described by product specification.
Show Source
Nested Schema : ProductOfferingRelationship
Type: object
Title: ProductOfferingRelationship
The relationship between/among product offerings.
Show Source
Nested Schema : TaxServiceProviderRefOracle
Type: object
Title: TaxServiceProviderRefOracle
The tax Service Provider reference.
Show Source
Nested Schema : UsedByRef
Type: object
Title: UsedByRef
A reference to a resource that is aggregating another top-level resource.
Show Source
  • The base type of the used by reference.
  • The type of the referred used by reference.
  • The hyperlink reference to the used by reference.
  • The ID of the used by reference.
  • The name of the used by reference.
  • 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 type or classification of the used by reference.
  • The version of the using item.
Back to Top

Response

Supported Media Types

200 Response

The product offering was updated successfully.
Body ()
Root Schema : ProductOfferingOracle
Title: ProductOfferingOracle
Match All
Show Source
  • ProductOffering
    Title: ProductOffering
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOffering":"#/components/schemas/ProductOffering", "ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle" } }
    The product offering resource.
  • type
Nested Schema : ProductOffering
Type: object
Title: ProductOffering
Discriminator: @type

Discriminator Values

The product offering resource.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : approvalHistory
Type: array
A list of approval histories associated with the product offering.
Show Source
Nested Schema : ApprovalInfoOracle
Type: object
Title: ApprovalInfoOracle
The approval info resource.
Show Source
Nested Schema : approver
Type: array
A list of approvers associated with the product offering.
Show Source
Nested Schema : banner
Type: array
A list of banners associated with the product offering.
Show Source
Nested Schema : ChoiceRelationshipOracle
Title: ChoiceRelationshipOracle
Match All
Show Source
  • ProductOfferingRef
    Title: ProductOfferingRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
    The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
  • ChoiceRelationshipOracle-allOf[1]
Nested Schema : customProfileSpec
Type: array
A list of custom profile specifications associated with the product offering.
Show Source
Nested Schema : customProfSpecCharValueUse
Type: array
A list of custom prof specification characteristic value uses associated with the product offering.
Show Source
  • 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 for example 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.
Nested Schema : externalConfigurationProperties
Type: array
A list of external configuration properties associated with the product offering.
Show Source
  • ExternalConfigurationPropertiesOracle
    Title: ExternalConfigurationPropertiesOracle
    A use of the ExternalConfigurationPropertiesOracle 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 for example 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.
Nested Schema : marketingFeature
Type: array
A list of marketing features associated with the product offering.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
The custom Profile specification reference.
Show Source
Nested Schema : pricelist
Type: array
A list of pricelists associated with the product offering.
Show Source
Nested Schema : pricePlanRelationship
Type: array
A list of price plan relationships associated with the product offering.
Show Source
Nested Schema : productLine
Type: array
A list of product lines associated with the product offering.
Show Source
Nested Schema : productOfferingCharacteristic
Type: array
A list of product offering characteristics associated with the product offering.
Show Source
Nested Schema : ProductOfferingInfoOracle
Type: object
Title: ProductOfferingInfoOracle
The more information on the Product Offering.
Show Source
Nested Schema : productOfferingRelationship
Type: array
A list of product offering relationships associated with the product offering.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Nested Schema : searchTag
Type: array
A list of search tags associated with the product offering.
Show Source
Nested Schema : taxSupplier
Type: array
A list of tax suppliers associated with the product offering.
Show Source
Nested Schema : usedBy
Type: array
Read Only: true
A list of used bies associated with the product offering.
Show Source
Nested Schema : ApprovalHistory
Type: object
Title: ApprovalHistory
The approval history resource.
Show Source
Nested Schema : ApproverRef
Type: object
Title: ApproverRef
The approver reference resource.
Show Source
Nested Schema : BannerOracle
Type: object
Title: BannerOracle
The banner resource.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : ProductOfferingRef
Type: object
Title: ProductOfferingRef
Discriminator: @type

Discriminator Values

The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Show Source
Nested Schema : ChoiceRelationshipOracle-allOf[1]
Type: object
Show Source
  • ProductOfferingRef
    Title: ProductOfferingRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
    The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Nested Schema : CustomProfSpecCharValueUse
Type: object
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 for example 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.
Show Source
Nested Schema : customProfileSpecCharValue
Type: array
A list of custom profile specification characteristic values associated with the custom prof specification characteristic value use.
Show Source
Nested Schema : CustomProfileSpecCharValue
Type: object
Title: CustomProfileSpecCharValue
A number or text that can be assigned to a CustomProfileSpecCharacteristic.
Show Source
  • The base type of the custom profile specification characteristic value.
  • The URI of the schema that defines the custom profile specification characteristic value.
  • The class type of the custom profile specification characteristic value.
  • A string. A word, term, or phrase by which can be displyed for user experience.
  • Whether the custom profile specification characteristic value has enabled.
  • Whether the custom profile specification characteristic value is default.
  • 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". Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.
  • The regular expression to define constraint on the allowed value.
  • The order sequence for the values input.
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    The unit can be minutes or GB.
  • TimePeriodOracle
    Title: TimePeriodOracle
    The validity period of the related party.
  • value
    A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
  • The low range value that a characteristic can take on.
  • The ID of the value reference associated with the custom profile specification characteristic value.
  • Allowed Values: [ "SERVICE_SPEC" ]
    The type or classification of the custom profile specification characteristic value. Valid values are SERVICE_SPEC.
  • The upper range value that a characteristic can take on.
  • Allowed Values: [ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME", "PRODUCT_OFFER", "PRODUCT_SPEC", "PRODUCT_LINE", "SPEC_CHAR" ]
    The type or classification of the custom profile specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, PRODUCT_OFFER, PRODUCT_SPEC, PRODUCT_LINE, and SPEC_CHAR.
Nested Schema : value
A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Nested Schema : ExternalConfigurationPropertiesOracle
Type: object
Title: ExternalConfigurationPropertiesOracle
A use of the ExternalConfigurationPropertiesOracle 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 for example 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.
Show Source
Nested Schema : externalConfigurationValue
Type: array
A list of external configuration values associated with the external configuration property.
Show Source
Nested Schema : ExternalConfigurationValueOracle
Title: ExternalConfigurationValueOracle
Match All
Show Source
Nested Schema : FeatureOracle
Type: object
Title: FeatureOracle
The feature resource.
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid.
Show Source
Nested Schema : PriceListGroupRefOracle
Type: object
Title: PriceListGroupRefOracle
The price list group reference.
Show Source
Nested Schema : productOfferingPrice
Type: array
A list of product offering prices associated with the price list group reference.
Show Source
  • ProductOfferingPriceRef
    Title: ProductOfferingPriceRef
    The productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
Nested Schema : productOfferingTerm
Type: array
A list of product offering terms associated with the price list group reference.
Show Source
Nested Schema : ProductOfferingPriceRef
Type: object
Title: ProductOfferingPriceRef
The productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
Show Source
Nested Schema : TermSummary
Type: object
Title: TermSummary
The product offering term summary resource.
Show Source
Nested Schema : TermDuration
Title: TermDuration
Match All
Show Source
Nested Schema : Quantity
Type: object
Title: Quantity
A number and unit representing how many of an ProductOffering is available at the offered price.
Show Source
  • A quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
  • 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].
Nested Schema : TermDuration-allOf[1]
Type: object
Show Source
  • Allowed Values: [ "DAYS", "MONTHS", "WEEKS", "YEARS" ]
    The term duration units. Valid values are DAYS, MONTHS, WEEKS, and YEARS.
Nested Schema : PricePlanRelationshipOracle
Title: PricePlanRelationshipOracle
Match All
Show Source
Nested Schema : PricePlanRelationshipOracle-allOf[1]
Type: object
Show Source
Nested Schema : applicableProductOffering
Type: array
A list of applicable product offerings associated with the price plan relationship.
Show Source
Nested Schema : popRelationship
Type: array
A list of pop relationships associated with the price plan relationship.
Show Source
Nested Schema : ApplicableProductOfferingOracle
Title: ApplicableProductOfferingOracle
Match All
Show Source
  • ProductOfferingRef
    Title: ProductOfferingRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
    The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
  • ApplicableProductOfferingOracle-allOf[1]
Nested Schema : ApplicableProductOfferingOracle-allOf[1]
Type: object
Show Source
Nested Schema : ProductOfferingPriceRelationshipOracle
Title: ProductOfferingPriceRelationshipOracle
Match All
Show Source
Nested Schema : ProductOfferingPriceRelationship
Type: object
Title: ProductOfferingPriceRelationship
The product offering price relationship.
Show Source
Nested Schema : ProductOfferingPriceRelationshipOracle-allOf[1]
Type: object
Show Source
Nested Schema : ProductLineRef
Type: object
Title: ProductLineRef
The product line reference resource.
Show Source
Nested Schema : ProductOfferCharacteristicOracle
Title: ProductOfferCharacteristicOracle
Match All
Show Source
  • 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 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.
  • ProductOfferCharacteristicOracle-allOf[1]
Nested Schema : CharacteristicSpecification
Type: object
Title: CharacteristicSpecification
Discriminator: @type

Discriminator Values

A characteristic quality or distinctive feature of a PlaSpecification. The characteristic can 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.
Show Source
Nested Schema : ProductOfferCharacteristicOracle-allOf[1]
Type: object
Show Source
  • Read only value, if true, the Boolean indicates that the productSpecCharacteristic is configurable.
  • A narrative that explains in detail what the productSpecCharacteristic is.
  • The name of the display associated with the product offer characteristic.
  • The name of the product offer characteristic.
  • ProductSpecificationRef
    Title: ProductSpecificationRef
    The 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.
  • The type or classification of the product offer characteristic.
Nested Schema : ProductSpecificationRef
Type: object
Title: ProductSpecificationRef
The 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.
Show Source
Nested Schema : TargetProductSchema
Type: object
Title: TargetProductSchema
The reference object to the schema and type of target product which is described by product specification.
Show Source
Nested Schema : ProductOfferingRelationship
Type: object
Title: ProductOfferingRelationship
The relationship between/among product offerings.
Show Source
Nested Schema : TaxServiceProviderRefOracle
Type: object
Title: TaxServiceProviderRefOracle
The tax Service Provider reference.
Show Source
Nested Schema : UsedByRef
Type: object
Title: UsedByRef
A reference to a resource that is aggregating another top-level resource.
Show Source
  • The base type of the used by reference.
  • The type of the referred used by reference.
  • The hyperlink reference to the used by reference.
  • The ID of the used by reference.
  • The name of the used by reference.
  • 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 type or classification of the used by reference.
  • The version of the using item.

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source
Back to Top

Examples

The following example shows how to update a product offering by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u username:password -X PATCH \ 'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/TestProdOffering00020 -H 'Content-Type: application/json' -D @update_productoffering.json | json_pp

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "id": "TestProdOffering00020",
    "name": "Base Station PO TestProdOffering00020",
    "lifecycleStatus": "In study",
    "description": "Base Station Product for TestProdOffering00020",
    "version": "2.0",
    "@type": "ProductOfferingOracle",
    "@baseType": "ProductOffering",
    "isBundle": false,
    "project": {
        "id": "DocProject",
        "name": "Doc Project"
    },
    "productOfferingInfo" : {
        "productType" : "DEVICE"
    },
    "productSpecification": {
        "id": "ProdSpecProject0001234",
        "name": "ProdSpecProject0001234",
        "@referredType": "ProductSpecificationOracle"
    },
    "prodSpecCharValueUse": [
        {
            "name": "connectivity",
            "description": "Connectivity",
            "valueType": "STRING",
            "maxCardinality": 1,
            "productSpecCharacteristicValue": [
                {
                    "validFor": {
                        "startDateTime": "2019-08-14T20:42:23.0Z"
                    },
                    "isDefault": true,
                    "unitOfMeasure": "NONE",
                    "value": "5G",
                    "valueType": "STRING"
                }
            ],
            "productSpecification": {
                "id": "ProdSpecProject0001234",
                "name": "ProdSpecProject0001234",
                "@referredType": "ProductSpecificationOracle"
            }
        }
    ]
}

Example of Response Body

The following example shows the contents of the response body in JSON format.
{
    "id": "TestProdOffering00020",
    "name": "Base Station PO TestProdOffering00020",
    "lifecycleStatus": "In study",
    "description": "Base Station Product for TestProdOffering00020",
    "version": "2.0",
    "@type": "ProductOfferingOracle",
    "@baseType": "ProductOffering",
    "isBundle": false,
    "project": {
        "id": "DocProject",
        "name": "Doc Project"
    },
    "productOfferingInfo": {
        "productType": "DEVICE"
    },
    "productSpecification": {
        "id": "ProdSpecProject0001234",
        "name": "ProdSpecProject0001234",
        "@referredType": "ProductSpecificationOracle",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/ProdSpecProject0001234",
        "version": "1.0",
        "@baseType": "ProductSpecificationOracle"
    },
    "prodSpecCharValueUse": [
        {
            "name": "connectivity",
            "description": "Connectivity",
            "valueType": "STRING",
            "maxCardinality": 1,
            "productSpecCharacteristicValue": [
                {
                    "validFor": {
                        "startDateTime": "2019-08-14T20:42:23.0Z"
                    },
                    "isDefault": true,
                    "unitOfMeasure": "NONE",
                    "value": "5G",
                    "valueType": "STRING"
                }
            ],
            "productSpecification": {
                "id": "ProdSpecProject0001234",
                "name": "ProdSpecProject0001234",
                "@referredType": "ProductSpecificationOracle"
            }
        }
    ],
    "lastUpdate": "2020-08-20T16:25:28.000Z",
    "isSellable": false,
    "lastUpdatedBy": "anonymous",
    "createdBy": "anonymous",
    "created": "2020-08-20T16:25:27.000Z",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/TestProdOffering00020"
}
Back to Top