1. REST API for Oracle Commerce Cloud 21B
  2. Tasks
  3. Admin
  4. PriceListGroup

createPriceListGroup

post

/ccadmin/v1/priceListGroups

Create a new PriceListGroup. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types
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 : createPriceListGroup_request
Type: object
Show Source
  • If true, this PLG will be associated to the site which is passed as part of query param (siteId). Else it will be associated to default site. If false it would not be associated with any site.
  • basePriceListGroup
    The base price list group of this price list group.
  • The display name of the PriceListGroup.
  • End date of the associated price lists
  • Id to create PriceListGroup with.
  • If true, and active flag is also set to true then list price is mandatory for all products. This flag will automatically be set to false for child price list groups and cannot be update.
  • Indicates whether prices are inclusive of tax. If the basePriceListGroup is passed, the isTaxIncluded will always be overridden by its isTaxIncluded.
  • The locale with which the PriceListGroup is to be created. If the basePriceListGroup is passed, the locale will always be overridden by its locale.
  • Start date of the associated price lists
  • Indicates how tax calls are made based on the price list group setting. For a monetary price list group, the possible values are calculateTax and doNotCalculateTax with default being calculateTax. For a point based price list group, the possible values are doNotCalculateTax, calculateTaxWithCurrencyConversion and calculateTaxWithoutCurrencyConversion with default being doNotCalculateTax. If the base price list group is passed, the taxCalculationType will always be overridden by its taxCalculationType.
Example:
{
    "isTaxIncluded":false,
    "taxCalculationType":"calculateTax",
    "displayName":"Canadian Dollar",
    "id":"canadianDollar",
    "locale":"en_CA",
    "basePriceListGroup":{
        "id":"canadianDollarSale"
    },
    "includeAllProducts":true,
    "associatePriceListGroupToSite":true
}
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 : createPriceListGroup_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":null,
    "displayName":"Canadian Dollar",
    "listPriceList":{
        "repositoryId":"canadianDollar_listPrice"
    },
    "active":false,
    "isPointsBased":false,
    "basePriceListGroup":{
        "displayName":"Canadian Dollar Sale",
        "id":"canadianDollarSale"
    },
    "locale":"en_US",
    "shippingSurchargePriceList":{
        "repositoryId":"canadianDollar_shippingSurchargePrice"
    },
    "deleted":false,
    "taxCalculationType":"calculateTax",
    "repositoryId":"CanadianDollar",
    "currency":{
        "symbol":"$",
        "displayName":"Canadian Dollar",
        "repositoryId":"en_CA",
        "fractionalDigits":2,
        "currencyCode":"CAD",
        "numericCode":"840"
    },
    "links":[
        {
            "rel":"self",
            "href":"/priceListGroups"
        }
    ],
    "salePriceList":{
        "repositoryId":"canadianDollar_salePrice"
    },
    "id":"canadianDollar",
    "includeAllProducts":true,
    "startDate":null
}

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| |------------------|------------------| |20212|There was an error creating price list group| |20211|PriceListGroup with ID: {0} already exists| |20210|There was an error creating the price list| |13037|Missing required property: id| |13036|Locale key is not valid| |99000|The ID "**78" is invalid| |20206|price list group with display name: {0} already exists| |20217|The selected parent price list group is not found or is invalid.|
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