1. REST API Reference for Pricing Design Center TMF 620 API
  2. Tasks
  3. Product Offering Price

Get the Pricing for a Product Offering by ID

get

http://host:port/productCatalogManagement/v4/productOfferingPrice/{id}

Retrieves the details of pricing for a product offering with the given name.

Request

Path Parameters
Query Parameters
  • Specifies the attributes that need to be returned inside the resource item.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The product offering price was retrieved successfully.
Body ()
Root Schema : ProductOfferingPriceOracle
Type: object
Title: ProductOfferingPriceOracle
Match All
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice", "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle" } }
    It is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (a product offering price that reflects an alteration). The price applied for a product offering may also be influenced by factors such as the product offering term, the customer selected etc. For example, a product offering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this product offering term. A product offering may be cheaper with a 24 month commitment than with a 12 month commitment.
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle" } }
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

It is based on both the basic cost to develop and produce products and the enterprises policy on revenue targets. This price may be further revised through discounting (a product offering price that reflects an alteration). The price applied for a product offering may also be influenced by factors such as the product offering term, the customer selected etc. For example, a product offering can be offered with multiple terms, like commitment periods for the contract. The price may be influenced by this product offering term. A product offering may be cheaper with a 24 month commitment than with a 12 month commitment.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source

400 Response

The server cannot process the request due to a client error.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source

401 Response

The user's authentication credentials for the target resource are invalid.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source

404 Response

The requested resource was not found, but it could be accessible in the future. Subsequent client requests are permitted.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source

405 Response

The requested resource does not support the particular request method.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source

500 Response

When an unexpected condition is identified and no specific message is appropriate, this generic error message is displayed.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error, typically with an HTTP error response-code.
Show Source
Back to Top

Examples

Example 1: Get a Product Offering Price by ID using a One Time Charge

The following example shows how to get a product offering price by ID using a one time charge of $100 as an example by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Note:

The atType in the response payload will be "atType": "ProductOfferingPriceOracle". 

curl -X GET 'http://hostname:port/productCatalogManagement/v4/productOfferingPrice/OT_charge_1'

where:

  • hostname is the URL for the PDC REST server.

  • port is the port for the PDC REST server.

Example of the Response Body

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

{
    "atBaseType": "ProductOfferingPrice",
    "atType": "ProductOfferingPriceOracle",
    "eventCandidate": {
        "name": "EventBillingProductFeePurchase"
    },
    "href": "/productCatalogManagement/v4/productOfferingPrice/OT_charge_1",
    "id": "OT_charge_1",
    "isBundle": false,
    "lastUpdate": "2023-09-06T23:41:15Z",
    "lifecycleStatus": "Active",
    "name": "OT_charge_1",
    "priceType": "ONE_TIME",
    "rumCandidate": {
        "name": "OCCURRENCE"
    },
    "validFor": {
        "endDateTime": "2023-05-01T00:33:55Z",
        "startDateTime": "2023-04-02T00:33:50Z"
    },
    "version": "1.0",
    "priceAlteration": [
        {
            "atType": "POPAlterationOracle",
            "price": {
                "atType": "ProductPriceValueOracle",
                "dutyFreeAmount": {
                    "unit": "USD",
                    "value": 100.0
                }
            }
        }
    ]
}

Example 2: Get a Product Offering Price by ID using a Charge Selector

The following example shows how to get the details of a product offering price by ID using a charge selector submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Note:

The @type in the response payload will be "@type": "ProductOfferingPriceSelectorOracle". 

curl -X GET 'http://hostname:port/productCatalogManagement/v4/productOfferingPrice/ChargeSelectorPop'

where:

  • hostname is the URL for the PDC REST server.

  • port is the port for the PDC REST server.

Example of the Response Body

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

{
    "atBaseType": "ProductOfferingPrice",
    "atType": "ProductOfferingPriceSelectorOracle",
    "constraint": [
        {
            "atType": "ConstraintOracle",
            "name": "ChargeSelectorPop",
            "constraintRule": [
                {
                    "name": "rule1",
                    "productOfferingPrice": [
                        {
                            "atBaseType": "ProductOfferingPrice",
                            "atType": "ProductOfferingPriceOracle",
                            "eventCandidate": {
                                "name": "EventBillingProductFeePurchase"
                            },
                            "href": "/productCatalogManagement/v4/productOfferingPrice/ChargeSelectorPopRule_1",
                            "id": "ChargeSelectorPopRule_1",
                            "isBundle": false,
                            "lastUpdate": "2024-04-16T22:42:18Z",
                            "lifecycleStatus": "Active",
                            "name": "ChargeSelectorPopRule_1",
                            "priceType": "ONE_TIME",
                            "pricingLogicAlgorithm": [
                                {
                                    "atType": "PricingLogicAlgorithmOracle",
                                    "id": "ChargeSelectorPopRule_1_PlaId_1",
                                    "name": "ChargeSelectorPopRule_1_PlaId_1",
                                    "tierRange": {
                                        "minQuantity": "0",
                                        "productOfferingPriceTierRanges": [
                                            {
                                                "atType": "ProductOfferingPriceOracle",
                                                "id": "ChargeSelectorPopRule_1_tier1",
                                                "name": "ChargeSelectorPopRule_1_tier1",
                                                "priceType": "ONE_TIME",
                                                "maxQuantity": "10",
                                                "priceAlteration": [
                                                    {
                                                        "atType": "POPAlterationOracle",
                                                        "price": {
                                                            "atType": "ProductPriceValueOracle",
                                                            "dutyFreeAmount": {
                                                                "unit": "USD",
                                                                "value": 100
                                                            }
                                                        }
                                                    }
                                                ]
                                            }
                                        ]
                                    }
                                }
                            ],
                            "rumCandidate": {
                                "name": "NONE"
                            },
                            "version": "1.0"
                        }
                    ],
                    "valueRelationship": [
                        {
                            "fieldKind": "PRODUCT_SPEC_FIELD",
                            "fieldName": "TelcoGsm.NAME",
                            "fieldValue": "*",
                            "operation": "EQUAL_TO",
                            "separator": ";"
                        }
                    ]
                }
            ],
            "stereoType": "CHARGE_RATE_PLAN_SELECTOR"
        }
    ],
    "eventCandidate": {
        "name": "EventBillingProductFeePurchase"
    },
    "href": "/productCatalogManagement/v4/productOfferingPrice/ChargeSelectorPop",
    "id": "ChargeSelectorPop",
    "isBundle": false,
    "lifecycleStatus": "Active",
    "name": "ChargeSelectorPop",
    "popRelationship": [
        {
            "atType": "ProductOfferingPriceRelationship",
            "id": "ChargeSelectorPopRule_1",
            "name": "ChargeSelectorPopRule_1",
            "relationshipType": "COMPOSITE"
        }
    ],
    "priceType": "ONE_TIME",
    "version": "1.0",
    "serviceCandidate": {
        "atType": "ServiceCandidateRef",
        "id": "TelcoGsm",
        "name": "TelcoGsm"
    }
}
Back to Top