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

Update a pricelist

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/{id}

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : PricelistOracle
Type: object
Title: PricelistOracle
A list of offers and its coresponding prices which can be used for selling the offer in a region or a particular set of customers
Show Source
Nested Schema : BalanceElementRef
Type: object
Title: BalanceElementRef
Balance element ref in price
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : RelatedParty
Type: object
Title: RelatedParty
RelatedParty reference. A related party defines party or party role linked to a specific entity.
Show Source
Nested Schema : partyOrPartyRole
Type: array
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : PricelistOracle
Type: object
Title: PricelistOracle
A list of offers and its coresponding prices which can be used for selling the offer in a region or a particular set of customers
Show Source
Nested Schema : BalanceElementRef
Type: object
Title: BalanceElementRef
Balance element ref in price
Show Source
Nested Schema : productOffering
Type: array
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 : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : promotion
Type: array
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
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 : PromotionRef
Type: object
Title: PromotionRef
Promotion reference.
Show Source
Nested Schema : RelatedParty
Type: object
Title: RelatedParty
RelatedParty reference. A related party defines party or party role linked to a specific entity.
Show Source
Nested Schema : partyOrPartyRole
Type: array
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 : 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 update a price list by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u username:password -X PATCH \ 
'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/TestPrice90 -H 'Content-Type: application/json' -D @update_pricelist.json | json_pp

Example of Request Body

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

{
    "description" : "DBE North America Pricelist",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
}

Example of Response Body

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

{
    "lastUpdate": "2025-02-17T12:34:59.052Z",
    "lastUpdatedBy": "booth",
    "created": "2025-02-17T12:34:59.000Z",
    "createdBy": "booth",
    "versionState": 0,
    "id": "DBE_NA_PL1",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/DBE_NA_PL1",
    "name": "DBE NA Pricelist1",
    "description" : "DBE North America Pricelist",
    "@type": "PricelistOracle",
    "version": "1.0",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
    "project": {
        "id": "DBE_RI_ProdModel_PreSeed_PSP",
        "name": "DBE RI Product Model Preseed",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "lifecycleStatus": "In design",
    "currency": "USD",
    "pricelistType": "BUSINESS"
}
Back to Top