REST API Reference for Launch Cloud Service

Get all product offering prices

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice

Request

Query Parameters

@baseType: string

The base class type of the resource.
@schemaLocation: string

The link to the location where the scheme of the resource is defined.
@type: string

The class type of the resource.
constraint.productSpecification.id: string

Filter Offerings based on constarint Product Specification Id
description: string

The description of the resource.
eligibleForProject: string

Project Id
fields: string

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.
id: string

The unique identifier of the resource item.
lifecycleStatus: string

The current lifecycle status of the resource.
limit: integer

The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
name: string

The name of the resource.
offset: string

The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
percentage: string

The discount percentage applied for the product offering.
price.value: number

Filter Offer Price based on price value
priceSubType: string

The price sub types (such as Installment, Lease, Down Payment etc) applicable to a product offering.
priceType: string

The price types (such as a discount, penalty, allowance, and so on) applicable to a product offering.
pricelist.id: string

Filter Offerings based on Price List Id
pricelist.name: string

Filter Offerings based on Price List Name
recurringChargePeriodLength: string

The period (for example, 1 week, 2 months) for which the recurring charge is applied. If set to zero, then the charge is not applicable.
recurringChargePeriodType: string

The frequency (for example, weekly, monthly) for which the recurring charge is applied.
version: string

The current version of the resource.
whereUsed: string

enrich objects with usedBy information

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: array

Show Source

Array of: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/ProductOfferingPriceOracle"
            },
            {
                "$ref":"#/components/schemas/ProductOfferingPriceAlterationOracle"
            },
            {
                "$ref":"#/components/schemas/ProductOfferingPriceAllowanceOracle"
            },
            {
                "$ref":"#/components/schemas/ProductOfferingPriceCounterOracle"
            },
            {
                "$ref":"#/components/schemas/ProductOfferingPriceOverageOracle"
            },
            {
                "$ref":"#/components/schemas/ProductOfferingPricePlanOracle"
            },
            {
                "$ref":"#/components/schemas/PenaltyPriceOracle"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
                "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
                "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
                "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
                "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
                "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
                "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
            }
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAlterationOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAllowanceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceCounterOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOverageOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPricePlanOracle"
        },
        {
            "$ref":"#/components/schemas/PenaltyPriceOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
            "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
            "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
            "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
            "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
            "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
            "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
        }
    }
}

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.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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/v4//productOfferingPrice \ -H 'Content-Type: application/json'

Example of Response Body

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

[
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/popShareAllowanceTst123",
        "id": "popShareAllowanceTst123",
        "lastUpdate": "2020-07-14T09:42:39.846Z",
        "version": "A"
    },
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP-2264407618-1594103819620",
        "id": "POP-2264407618-1594103819620",
        "lastUpdate": "2020-07-07T06:38:03.63Z",
        "version": "1.0",
        "isBundle": true,
        "@type": "ProductOfferingPriceOracle",
        "lifecycleStatus": "In design",
        "name": "PRICEf9aa766f4d9b4d75a5114cae2062ae78",
        "bundledPopRelationship": [
            {
                "id": "POP-1949444329-1594054571327",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP-1949444329-1594054571327",
                "name": "Purchase fee",
                "@type": "ProductOfferingPriceOracle",
                "lifecycleStatus": "In design"
            },
            {
                "id": "DiscountPOP-2972209452-1594103819619",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/DiscountPOP-2972209452-1594103819619",
                "name": "DiscountPOP-2972209452-1594103819619",
                "@type": "ProductOfferPriceAlterationOracle",
                "lifecycleStatus": "In design"
            }
        ]
    },
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP-1818264892-1594103819786",
        "id": "POP-1818264892-1594103819786",
        "lastUpdate": "2020-07-07T06:38:03.679Z",
        "version": "1.0",
        "project": {
            "id": "PSPSummerProj",
            "name": "Summer Project"
        },
        "isBundle": true,
        "@type": "ProductOfferingPriceOracle",
        "lifecycleStatus": "In design",
        "name": "PRICE608564fc24d5414e9ea0eb7a3d4e85cf",
        "bundledPopRelationship": [
            {
                "id": "POP-3450619274-1594099310218",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP-3450619274-1594099310218",
                "name": "PRICEf2d4f7342ec8400a9a5cd787cb1e5bf1",
                "@type": "ProductOfferingPriceOracle",
                "lifecycleStatus": "In design"
            },
            {
                "id": "POP-2264407618-1594103819620",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP-2264407618-1594103819620",
                "@type": "ProductOfferingPriceOracle"
            }
        ]
    },
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/HomeSecurityDeviceBundlePriceStandalone6790",
        "id": "HomeSecurityDeviceBundlePriceStandalone6790",
        "lastUpdate": "2020-07-09T10:36:51.457Z",
        "version": "1.0",
        "project": {
            "id": "16203",
            "name": "ImportJob_16203",
            "version": "1.0"
        },
        "isBundle": true,
        "discountable": false,
        "billOnPurchase": false,
        "@type": "ProductOfferingPriceOracle",
        "@baseType": "ProductOfferingPrice",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductOfferingPriceOracle.yml",
        "recurringChargePeriodLength": 0,
        "lifecycleStatus": "Ready to publish",
        "name": "Home Security Device Bundle Price6790",
        "description": "Home Security Device Bundle Price",
        "bundledPopRelationship": [
            {
                "id": "HomeDoorSensorPrice6790",
                "name": "Home Door Sensor one-time charges6790"
            },
            {
                "id": "HomeWindowSensorPrice6790",
                "name": "Home Window one-time charges6790"
            },
            {
                "id": "HomeMotionSensorPrice6790",
                "name": "Motion Sensor one time charges6790"
            },
            {
                "id": "HomeOutdoorCameraPrice6790",
                "name": "Outdoor Camera one time charges6790"
            },
            {
                "id": "HomeIndoorCameraPrice6790",
                "name": "Indoor Camera one time charges6790"
            },
            {
                "id": "HomeBaseStationPrice6790",
                "name": "Home Base Station Price6790"
            }
        ]
    },
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/Oracle_XSXST01P",
        "id": "Oracle_XSXST01P",
        "lastUpdate": "2020-07-23T07:51:26.673Z",
        "version": "1.0",
        "pricingLogicAlgorithm": [
            {
                "id": "Oracle_DXE6S05T",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/Oracle_DXE6S05T",
                "name": "Names_OII92Q42T",
                "@type": "PricingLogicAlgorithmOracle"
            }
        ],
        "isBundle": false,
        "priceType": "ALTERATION",
        "@type": "ProductOfferPriceAlterationOracle",
        "@baseType": "ProductOfferingPriceOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductOfferPriceAlterationOracle.yml",
        "percentage": 30,
        "lifecycleStatus": "In design",
        "name": "Names_GDPHUE9PN"
    }
	....
]