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

Create or update an array of product offering prices

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferingPrices

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 50
Show Source
Nested Schema : ProductOfferingPriceOracle
Title: ProductOfferingPriceOracle
Match All
Show Source
  • ProductOfferingPrice
    Title: ProductOfferingPrice
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice", "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
Nested Schema : ProductOfferingPrice
Type: object
Title: ProductOfferingPrice
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source
Back to Top

Response

Supported Media Types

200 Response

Your request is successful and the resources have been created or updated.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ProductOfferingPriceOracle
Title: ProductOfferingPriceOracle
Match All
Show Source
  • ProductOfferingPrice
    Title: ProductOfferingPrice
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice", "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle", "ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle", "ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle", "ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle", "ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle", "ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle", "ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle", "PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle" } }
Nested Schema : ProductOfferingPrice
Type: object
Title: ProductOfferingPrice
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Show Source

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 : schema
Type: array
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

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 does not 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 create or update an array of product offering price by submitting a put request on the REST resource using cURL.

cURL Command

curl -u username:password -X \ PUT https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferingPrices/ \-H 'Content-Type: application/json' -D @put_productofferingprices.json | json_pp

Example of Request Body

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

[
{
    "@type": "ProductOfferPriceAllowanceOracle",
    "@baseType": "ProductOfferingPriceOracle",
    "id": "PriceAllowance_001_Y2021",
    "name": "PriceAllowance_001_Y2021",
    "description": "AutomationPOP012 description",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "isBundle": false,
    "discountable": false,
    "billOnPurchase": false,
    "validFor": {
        "startDateTime": "2019-07-17T00:00:00.0Z",
        "endDateTime": "2020-06-19T00:00:00.0Z"
    },
    "priceType": "PENALTY",
"priceSubType": "UPGRADE_FEE",
    "price": {
        "unit": "USD",
        "value": 0.1
    },
  "project": {
              "id": "BulkDocProject",
        "name": "Bulk Doc Project"
    }
},
{
    "id": "POP_DISCOUNT_Y2021",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/POP_DISCOUNT_10003",
    "name": "POP_DISCOUNT_Y2021",
    "description": "Wireless Text Discount when buying with Supremo Unlimited",
    "version": "1.0",
    "priceType": "ALTERATION",
    "@type": "ProductOfferPriceAlterationOracle",
    "@baseType": "ProductOfferingPrice",
    "isBundle": false,
    "lastUpdate": "2021-06-14T21:42:08.705Z",
    "lifecycleStatus": "In design",
    "percentage": 100,
    "lastUpdatedBy": "anonymous",
    "created": "2021-04-12T02:23:54.204Z",
    "createdBy": "booth",
    "pricelist": [
        {
            "name": "Communication PriceList DX4C 001",
            "id": "CommsPriceListDX4C001",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/US_PL_1",
            "@baseType": "PricelistOracle"
        }
    ],
    "validFor": {
        "startDateTime": "2021-01-01T00:00:00.000Z"
    },
     "project": {
              "id": "BulkDocProject",
        "name": "Bulk Doc Project"
    }
},
{
    "@type": "ProductOfferingPriceOracle",
    "@baseType": "ProductOfferingPrice",
    "id": "PriceBundle_Y2021_PRICE",
    "name": "PriceBundle_Y2021_PRICE",
    "description": "AutomationPOP012 description",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "isBundle": true,
    "discountable": false,
    "billOnPurchase": false,
    "validFor": {
        "startDateTime": "2019-07-17T00:00:00.0Z",
        "endDateTime": "2020-06-19T00:00:00.0Z"
    },
    "priceType": "ONE_TIME",
    "price": {
        "unit": "USD",
        "value": 500
    },
    "project": {
              "id": "BulkDocProject",
        "name": "Bulk Doc Project"
    },
    "bundledPopRelationship": [
        {
            "@type": "ProductOfferingPriceOracle",
            "id": "Price001",
            "name": "Price001"
        },
        {
            "@type": "ProductOfferingPriceOracle",
            "id": "Price002",
            "name": "Price002"
        },
        {
            "@type": "ProductOfferingPriceOracle",
            "id": "Price003",
            "name": "Price003"
        }
    ]
}
]

Example of Response Body

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

[
    {
        "id": "PriceAllowance_001_Y2021",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferingPrices/PriceAllowance_001_Y2021",
        "name": "PriceAllowance_001_Y2021",
        "description": "AutomationPOP012 description",
        "version": "1.0",
        "priceType": "PENALTY",
        "@type": "ProductOfferPriceAllowanceOracle",
        "@baseType": "ProductOfferingPriceOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductOfferPriceAllowanceOracle.yml",
        "isBundle": false,
        "lifecycleStatus": "In design",
        "priceSubType": "UPGRADE_FEE",
        "balanceElement": [
            {
                "id": "USACurrency",
                "name": "USA Currency",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement/USACurrency",
                "@referredType": "BalanceElementOracle"
            }
        ],
        "price": {
            "unit": "USD",
            "value": 0.1
        },
        "validFor": {
            "startDateTime": "2019-07-17T00:00:00.0Z",
            "endDateTime": "2020-06-19T00:00:00.0Z"
        },
        "discountable": false,
        "billOnPurchase": false,
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        }
    },
    {
        "id": "POP_DISCOUNT_Y2021",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferingPrices/POP_DISCOUNT_Y2021",
        "name": "POP_DISCOUNT_Y2021",
        "description": "Wireless Text Discount when buying with Supremo Unlimited",
        "version": "1.0",
        "priceType": "ALTERATION",
        "@type": "ProductOfferPriceAlterationOracle",
        "@baseType": "ProductOfferingPrice",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductOfferPriceAlterationOracle.yml",
        "isBundle": false,
        "lifecycleStatus": "In design",
        "percentage": 100,
        "pricelist": [
            {
                "id": "CommsPriceListDX4C001",
                "name": "Communication PriceList DX4C 001",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/CommsPriceListDX4C001",
                "version": "1.0",
                "@baseType": "PricelistOracle"
            }
        ],
        "validFor": {
            "startDateTime": "2021-01-01T00:00:00.000Z"
        },
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        }
    },
    {
        "id": "PriceBundle_Y2021_PRICE",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productOfferingPrices/PriceBundle_Y2021_PRICE",
        "name": "PriceBundle_Y2021_PRICE",
        "description": "AutomationPOP012 description",
        "version": "1.0",
        "priceType": "ONE_TIME",
        "@type": "ProductOfferingPriceOracle",
        "@baseType": "ProductOfferingPrice",
        "isBundle": true,
        "lifecycleStatus": "In design",
        "balanceElement": [
            {
                "id": "USACurrency",
                "name": "USA Currency",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/balanceElement/USACurrency",
                "@referredType": "BalanceElementOracle"
            }
        ],
        "bundledPopRelationship": [
            {
                "@referredType": "ProductOfferingPriceOracle",
                "@type": "ProductOfferingPriceOracle",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/Price001",
                "name": "Price001",
                "id": "Price001"
            },
            {
                "@referredType": "ProductOfferingPriceOracle",
                "@type": "ProductOfferingPriceOracle",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/Price002",
                "name": "Price002",
                "id": "Price002"
            },
            {
                "@referredType": "ProductOfferingPriceOracle",
                "@type": "ProductOfferingPriceOracle",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/Price003",
                "name": "Price003",
                "id": "Price003"
            }
        ],
        "price": {
            "unit": "USD",
            "value": 500
        },
        "validFor": {
            "startDateTime": "2019-07-17T00:00:00.0Z",
            "endDateTime": "2020-06-19T00:00:00.0Z"
        },
        "discountable": false,
        "billOnPurchase": false,
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        }
    }
]
Back to Top