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

listPriceListGroups

get

/ccadmin/v1/priceListGroups

List Price List Groups. Get a list of PriceListGroups.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listPriceListGroups_response
Type: object
Show Source
Nested Schema : defaultPriceListGroup
Type: object
The default Price List Group
Show Source
Nested Schema : items
Type: array
List of PriceListGroups
Show Source
Nested Schema : sort
Type: array
Sorting criteria.
Show Source
Nested Schema : ancestorPriceListGroups
Type: array
Array of ancestor price list group ids (if any) for this price list group.
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
Nested Schema : items
Type: object
Show Source
Nested Schema : ancestorPriceListGroups
Type: array
Array of ancestor price list group ids (if any) for this price list group.
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
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":250,
    "defaultPriceListGroup":{
        "isTaxIncluded":false,
        "endDate":"2016-03-11T18:30:00.000Z",
        "displayName":"UsDollar",
        "listPriceList":{
            "repositoryId":"listPrices"
        },
        "active":false,
        "isPointsBased":false,
        "locale":"en_US",
        "basePriceListGroup":null,
        "shippingSurchargePriceList":{
            "repositoryId":"shippingSurchargePrices"
        },
        "taxCalculationType":"calculateTax",
        "ancestorPriceListGroups":[
        ],
        "repositoryId":"UsDollar",
        "salePriceList":{
            "repositoryId":"salePrices"
        },
        "currency":{
            "symbol":"$",
            "displayName":"US Dollar",
            "repositoryId":"en_US",
            "fractionalDigits":2,
            "currencyCode":"USD",
            "numericCode":"840"
        },
        "id":"UsDollar",
        "includeAllProducts":true,
        "startDate":"2016-03-10T18:30:00.000Z"
    },
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "endDate":"2016-03-11T18:30:00.000Z",
            "displayName":null,
            "listPriceList":{
                "repositoryId":"listPrices"
            },
            "active":false,
            "isPointsBased":false,
            "locale":"en_US",
            "basePriceListGroup":null,
            "shippingSurchargePriceList":null,
            "taxCalculationType":"calculateTax",
            "ancestorPriceListGroups":[
            ],
            "repositoryId":"UsDollar",
            "salePriceList":{
                "repositoryId":"salePrices"
            },
            "currency":{
                "symbol":"$",
                "displayName":"US Dollar",
                "repositoryId":"en_US",
                "fractionalDigits":2,
                "currencyCode":"USD",
                "numericCode":"840"
            },
            "id":"UsDollar",
            "includeAllProducts":true,
            "startDate":"2016-03-10T18:30:00.000Z"
        },
        {
            "isTaxIncluded":false,
            "endDate":"2016-03-11T18:30:00.000Z",
            "displayName":"CanadianDollar",
            "listPriceList":{
                "repositoryId":"CanadianDollar_listPrice"
            },
            "active":false,
            "isPointsBased":false,
            "basePriceListGroup":{
                "displayName":"Canadian Dollar Sale",
                "id":"canadianDollarSale"
            },
            "locale":"en_CA",
            "shippingSurchargePriceList":{
                "repositoryId":"CanadianDollar_shippingSurchargePrice"
            },
            "taxCalculationType":"calculateTax",
            "ancestorPriceListGroups":[
                "canadianDollarSale",
                "canadianDollarRoot"
            ],
            "repositoryId":"CanadianDollar",
            "salePriceList":{
                "repositoryId":"CanadianDollar_salePrice"
            },
            "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| |------------------|------------------| |20185|There was an error fetching the PriceListGroup list.|
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