1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. PriceListGroup

updatePriceListGroup

put

/ccadmin/v1/priceListGroups/{id}

Update Price List Group. Updates an existing PriceListGroup based on PriceListGroup ID provided,specific properties have to be specified for getting them updated. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Path Parameters
  • PriceListGroup ID corresponding to the PriceListGroup to be updated.
Query Parameters
  • If true, returns PriceListGroup's ancestor information in the response. Default is false.It can not be used to update base/ancestor price list groups. It is a read only property.
Header Parameters
Body ()
Root Schema : updatePriceListGroup_request
Type: object
Show Source
Example:
{
    "endDate":"2017-03-12T00:00:00.000+05:30",
    "displayName":"Canadian Dollar",
    "basePriceListGroup":{
        "id":"canadianDollarSale"
    },
    "includeAllProducts":false,
    "startDate":"2016-03-11T00:00:00.000+05:30"
}
Nested Schema : basePriceListGroup
Type: object
The base price list group of this price list group.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updatePriceListGroup_response
Type: object
Show Source
Nested Schema : basePriceListGroup
Type: object
The base price list group of this price list group.
Show Source
Nested Schema : currency
Type: object
The currency data.
Show Source
Nested Schema : listPriceList
Type: object
The price list for list prices
Show Source
Nested Schema : salePriceList
Type: object
The price list for sale prices
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
The price list for shipping surcharge prices
Show Source
Example Response (application/json)
{
    "isTaxIncluded":false,
    "endDate":"2016-03-11T18:30:00.000Z",
    "displayName":"Canadian Dollar",
    "listPriceList":{
        "repositoryId":"CanadianDollar_listPrice"
    },
    "active":false,
    "basePriceListGroup":{
        "displayName":"Canadian Dollar Sale",
        "id":"canadianDollarSale"
    },
    "locale":"en_US",
    "shippingSurchargePriceList":{
        "repositoryId":"CanadianDollar_shippingSurchargePrice"
    },
    "repositoryId":"CanadianDollar",
    "salePriceList":{
        "repositoryId":"CanadianDollar_salePrice"
    },
    "currency":{
        "symbol":"$",
        "displayName":"US Dollar",
        "repositoryId":"en_US",
        "fractionalDigits":2,
        "currencyCode":"USD",
        "numericCode":"840"
    },
    "links":[
        {
            "rel":"self",
            "href":"/priceListGroups/CanadianDollar"
        }
    ],
    "id":"CanadianDollar",
    "includeAllProducts":false,
    "startDate":"2016-03-10T18:30:00.000Z"
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |20187|No price list group found for the id : invalidId| |13036|Locale key is not valid| |20192|Attempt to change the value of a read only property id| |20402|Attempt to change the value of a read only property locale| |20403|Attempt to change the value of a read only property isTaxIncluded| |20406|Attempt to change the value of a read only property taxCalculationType| |20408|Include all Products cannot be set to true if there is a base price list group.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top