REST API Reference for Launch Cloud Service

Create a product offering price

post

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

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingPriceOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAlterationOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceCounterOracle"
        },
        {
            "$ref":"#/components/schemas/ProductOfferingPriceAllowanceOracle"
        },
        {
            "$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"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Your request is successful and a new resource has been created.

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

ProductOfferingPriceOracle
ProductOfferPriceAlterationOracle
ProductOfferPriceAllowanceOracle
ProductOfferPriceCounterOracle
ProductOfferPriceOverageOracle
ProductOfferPricePlanOracle
PenaltyPriceOracle

{
    "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 create a product offering price by submitting a POST request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{
    "id": "POP-HS-OTF1",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/POP-HS-OTF",
    "name": "Hotspot One Time Fee",
    "version": "1.0",
    "priceType": "ONE_TIME_PRICE_PLAN",
    "@type": "ProductOfferPricePlanOracle",
    "@baseType": "ProductOfferingPriceOracle",
    "isBundle": false,
    "lifecycleStatus": "In design",
    "isTaxInclusive": false,
    "validFor": {
        "startDateTime": "2024-09-03T00:00:00.000Z"
    },
    "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"
    },
    "price": {
        "value": 12.99,
        "unit": "USD"
    },
    "oneTimeFeeType": "PURCHASE",
    "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"
        }
    ]
}

Example of Response Body

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

{
    "id": "POP-HS-OTF1",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/POP-HS-OTF1",
    "name": "Hotspot One Time Fee",
    "version": "1.0",
    "priceType": "ONE_TIME_PRICE_PLAN",
    "@type": "ProductOfferPricePlanOracle",
    "@baseType": "ProductOfferingPriceOracle",
    "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductOfferPricePlanOracle.yml",
    "isBundle": false,
    "lastUpdate": "2025-02-17T12:28:20.045Z",
    "lifecycleStatus": "In design",
    "lastUpdatedBy": "booth",
    "created": "2025-02-17T12:28:20.000Z",
    "createdBy": "booth",
    "versionState": 0,
    "isTaxInclusive": false,
    "validFor": {
        "startDateTime": "2024-09-03T00:00:00.000Z"
    },
    "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"
    },
    "price": {
        "value": 12.99,
        "unit": "USD"
    },
    "oneTimeFeeType": "PURCHASE",
    "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"
        }
    ]
}