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

Get a product offering

get

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

Request

Path Parameters
Query Parameters
  • The lifecycle status and latest version of resource
    Allowed Values: [ "Launched", "Latest" ]
  • The depth at which a resource item occurs in a resource hierarchy.
  • Project Id
  • The sub-entities that are embedded into each resource item returned in the response. To avoid huge responses, any sub-entity that contains more than 500 items is not expanded, and it is returned as a usual link. The link can be used to retrieve the sub-entity in a separate call using the limit and offset parameters to control the response size.
    • Allowed Values: [ "productOffering.bundledProductOffering", "productOffering.bundledProductOffering.productOfferingPrice", "productOffering.productOfferingPrice.bundledPopRelationship", "productOffering.productOfferingPrice.pricingLogicAlgorithm", "productOffering.productOfferingPrice.policy", "productOffering.productOfferingTerm.productOfferingPrice", "productOffering.productOfferingTerm.customProfileSpec" ]
  • The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
  • The current version of the resource.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
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" } }
  • type
Nested Schema : ProductOffering
Type: object
Title: ProductOffering
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : approvalHistory
Type: array
Show Source
Nested Schema : ApprovalInfoOracle
Type: object
Title: ApprovalInfoOracle
Show Source
Nested Schema : approver
Type: array
Show Source
Nested Schema : banner
Type: array
Show Source
Nested Schema : ChoiceRelationshipOracle
Title: ChoiceRelationshipOracle
Denotes the choice bundle which is overriden by this bundle
Match All
Denotes the choice bundle which is overriden by this bundle
Denotes the choice bundle which is overriden by this bundle
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" } }
    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
Show Source
Nested Schema : customProfSpecCharValueUse
Type: array
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 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.
Nested Schema : marketingFeature
Type: array
Show Source
Nested Schema : pricelist
Type: array
Show Source
Nested Schema : pricePlanRelationship
Type: array
Show Source
Nested Schema : productLine
Type: array
Show Source
Nested Schema : productOfferingCharacteristic
Type: array
Show Source
  • 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.
Nested Schema : ProductOfferingInfoOracle
Type: object
Title: ProductOfferingInfoOracle
More information on the Product Offering
Show Source
Nested Schema : productOfferingRelationship
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : searchTag
Type: array
Show Source
Nested Schema : usedBy
Type: array
Read Only: true
Show Source
Nested Schema : ApprovalHistory
Type: object
Title: ApprovalHistory
Show Source
Nested Schema : ApproverRef
Type: object
Title: ApproverRef
Approver Reference
Show Source
Nested Schema : BannerOracle
Type: object
Title: BannerOracle
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : ProductOfferingRef
Type: object
Title: ProductOfferingRef
Discriminator: @type

Discriminator Values

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" } }
    ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
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 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.
Show Source
Nested Schema : customProfileSpecCharValue
Type: array
Show Source
Nested Schema : CustomProfileSpecCharValue
Type: object
Title: CustomProfileSpecCharValue
A number or text that can be assigned to a CustomProfileSpecCharacteristic.
Show Source
  • base class type (immediate parent) of the ProductSpecCharacteristic
  • Hyperlink reference to schema describing this object
  • The class type of the characteristic value
  • A string. A word, term, or phrase by which can be displyed for user experience.
  • A field which used to enable or disable the value selection
  • Indicates if the value is the default value for a characteristic
  • 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".
  • Regular expression to define constraint on the allowed value
  • 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" ]
    Could be minutes, GB...
  • TimePeriodOracle
    Title: TimePeriodOracle
    Validity period of the related party
  • value
    A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
  • The low range value that a characteristic can take on
  • Id of the resource referenced in the specification
  • Allowed Values: [ "SERVICE_SPEC" ]
    Type of the resource referenced in the specification
  • 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" ]
    A kind of value that the characteristic can take on, such as numeric, text, and so forth
Nested Schema : value
A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Nested Schema : FeatureOracle
Type: object
Title: FeatureOracle
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : PriceListRefOracle
Type: object
Title: PriceListRefOracle
Pricelist reference.
Show Source
Nested Schema : productOfferingPrice
Type: array
Show Source
  • ProductOfferingPriceRef
    Title: ProductOfferingPriceRef
    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
Show Source
Nested Schema : ProductOfferingPriceRef
Type: object
Title: ProductOfferingPriceRef
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
Term Summary Oracle
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" ]
    Term duration units
Nested Schema : PricePlanRelationshipOracle
Title: PricePlanRelationshipOracle
Relationship between a PricePlan and its price relationships in the context of an offer
Match All
Relationship between a PricePlan and its price relationships in the context of an offer
Relationship between a PricePlan and its price relationships in the context of an offer
Show Source
Nested Schema : PricePlanRelationshipOracle-allOf[1]
Type: object
Show Source
Nested Schema : applicableProductOffering
Type: array
Show Source
Nested Schema : popRelationship
Type: array
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" } }
    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
this object represents a pop relationship
Match All
this object represents a pop relationship
this object represents a pop relationship
Show Source
Nested Schema : ProductOfferingPriceRelationship
Type: object
Title: ProductOfferingPriceRelationship
this object represents a pop relationship
Show Source
Nested Schema : ProductOfferingPriceRelationshipOracle-allOf[1]
Type: object
Show Source
Nested Schema : ProductLineRef
Type: object
Title: ProductLineRef
Product Line Reference
Show Source
Nested Schema : 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.
Match All
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.
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.
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 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.
  • 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 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.
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
  • Friendly name of the associated productSpecCharacteristic
  • Name of the associated productSpecCharacteristic
  • 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.
  • A kind of value that the characteristic can take on, such as numeric, text and so forth
Nested Schema : ProductSpecificationRef
Type: object
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.
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
Relationship between/among product offerings.
Show Source
Nested Schema : UsedByRef
Type: object
Title: UsedByRef
A reference to a resource that is aggregating another top-level resource.
Show Source
  • Indicates the base (class) type of this REST resource
  • The Class type of using item
  • hyperlink reference of the using item
  • Unique identifier of the using item
  • Name of the using item
  • 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 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
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
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
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
Show Source

500 Response

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

Examples

The following example shows how to get a category by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/5024168ffcfc4628955823f2d6bc415b \ -H 'Content-Type: application/json'

Example of Response Body

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

{
    "id": "PO_DBE_SUP_SMS_2001",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/PO_DBE_SUP_SMS_2001",
    "name": "Supremo SMS 2001",
    "description": "Example of Service with Recurring fee that is Billed under a service and is tracked as asset.",
    "isBundle": false,
    "lastUpdate": "2025-02-17T12:21:27.227Z",
    "lifecycleStatus": "In design",
    "validFor": {
        "startDateTime": "2024-09-03T00:00:00.000Z"
    },
    "version": "1.0",
    "@type": "ProductOfferingOracle",
    "isSellable": true,
    "project": {
        "id": "DBE_RI_Mob_ProdModel_PSP",
        "name": "DBE RI Mobile Product Model",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "productSpecification": {
        "id": "DBE_TXT_MSG_PS",
        "name": "DBE Text Messaging PS",
        "version": "1.0",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/DBE_TXT_MSG_PS",
        "versionState": -1,
        "@referredType": "ProductSpecificationOracle",
        "@type": "ProductSpecificationRef",
        "@baseType": "ProductSpecificationOracle"
    },
    "lastUpdatedBy": "booth",
    "created": "2025-02-17T12:21:26.000Z",
    "createdBy": "booth",
    "versionState": 0,
    "productOfferingInfo": {
        "trackAsAsset": true,
        "fulfillmentItemCode": {
            "id": "DBE_VOIP_FIC_PS",
            "name": "VoIP PS",
            "version": "1.0",
            "@referredType": "ProductSpecificationOracle",
            "@type": "ProductSpecificationRefOracle"
        },
        "isConfigurable": false,
        "productType": "SERVICE",
        "isBillable": true,
        "allowManualOverride": false,
        "isShippable": false,
        "serviceInstance": false,
        "billingType": "SUBSCRIPTION",
        "billingServiceType": "/service/telco/gsm/sms",
        "pricingCommitType": "DYNAMIC",
        "dynamicDiscountMethod": "PERCENTAGE"
    },
    "pricelist": [
        {
            "id": "DBE_NA_PL",
            "name": "DBE NA Pricelist",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/DBE_NA_PL",
            "version": "1.0",
            "versionState": -1,
            "@referredType": "PricelistOracle",
            "@type": "PriceListGroupRefOracle",
            "@baseType": "PricelistOracle"
        }
    ],
    "serviceCandidate": {
        "versionState": -1,
        "id": "SS-DBE-TXT-MSG-SS",
        "href": "https://cptapcbqy.fusionapps.ocs.oc-test.com/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/SS-DBE-TXT-MSG-SS",
        "name": "DBE Text Messaging SS",
        "version": "1.0",
        "serviceCode": "/service/telco/gsm/sms",
        "@referredType": "ServiceSpecificationOracle",
        "@type": "ServiceCandidateRefOracle"
    },
    "productOfferingPrice": [
        {
            "id": "POP-SMS200-MCF",
            "name": "Supremo SMS 200 MCF",
            "version": "1.0",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/POP-SMS200-MCF",
            "versionState": -1,
            "refId": "300100626988876_POP-SMS200-MCF",
            "@referredType": "ProductOfferPricePlanOracle",
            "@type": "ProductOfferingPriceRef",
            "@baseType": "ProductOfferingPriceOracle"
        }
    ],
    "commercialName": "Supremo SMS 200"
}
Back to Top