1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Store
  4. PriceListGroup

listPriceListGroups

get

/ccstore/v1/priceListGroups

List Price List Groups. Get a list of PriceListGroups.

Request

Supported Media Types
  • application/json
Query Parameters
defaultFirst
Type: boolean
This for displaying default PriceListGroup first in the list
limit
Type: integer
The number of items to return.
offset
Type: integer
Index of the first element to return.
siteId
Type: string
Site ID of the site
sort
Type: string
Sorting criteria. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |property|string|The property the listing is sorted by.| |order|string|Sort order: asc or desc.|

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listPriceListGroups_response
Nested Schema : items
Type: array
List of PriceListGroups
Nested Schema : sort
Type: array
Sorting criteria.
Nested Schema : items
Type: object
Nested Schema : listPriceList
Type: object
Price List for list prices
Nested Schema : salePriceList
Type: object
Price List for sale prices.
Nested Schema : shippingSurchargePriceList
Type: object
Price List for shipping surcharge prices.
Nested Schema : items
Type: object
Example application/json

{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":250,
    "defaultPriceListGroup":{
        "displayName":"UsDollar",
        "listPriceList":{
            "repositoryId":"listPrices"
        },
        "repositoryId":"UsDollar",
        "active":false,
        "salePriceList":{
            "repositoryId":"salePrices"
        },
        "currency":{
            "symbol":"$",
            "displayName":"US Dollar",
            "repositoryId":"en_US",
            "fractionalDigits":2,
            "currencyCode":"USD",
            "numericCode":"840"
        },
        "id":"UsDollar",
        "locale":"en_US",
        "shippingSurchargePriceList":{
            "repositoryId":"shippingSurchargePrices"
        },
        "includeAllProducts":true
    },
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "displayName":null,
            "listPriceList":{
                "repositoryId":"listPrices"
            },
            "repositoryId":"UsDollar",
            "active":false,
            "salePriceList":{
                "repositoryId":"salePrices"
            },
            "currency":{
                "symbol":"$",
                "displayName":"US Dollar",
                "repositoryId":"en_US",
                "fractionalDigits":2,
                "currencyCode":"USD",
                "numericCode":"840"
            },
            "id":"UsDollar",
            "locale":"en_US",
            "shippingSurchargePriceList":{
                "repositoryId":"shippingSurcharge"
            },
            "includeAllProducts":true
        },
        {
            "displayName":"CanadianDollar",
            "listPriceList":{
                "repositoryId":"CanadianDollar_listPrice"
            },
            "repositoryId":"CanadianDollar",
            "active":false,
            "salePriceList":{
                "repositoryId":"CanadianDollar_salePrice"
            },
            "id":"CanadianDollar",
            "locale":"en_CA",
            "shippingSurchargePriceList":{
                "repositoryId":"CanadianDollar_shippingSurchargePrice"
            },
            "includeAllProducts":false
        }
    ]
}
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
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "total": 2,
  "totalResults": 2,
  "offset": 0,
  "limit": 250,
  "defaultPriceListGroup": {
    "displayName": "UsDollar",
    "listPriceList": {"repositoryId": "listPrices"},
    "repositoryId": "UsDollar",
    "active": false,
    "salePriceList": {"repositoryId": "salePrices"},
    "currency": {
      "symbol": "$",
      "displayName": "US Dollar",
      "repositoryId": "en_US",
      "fractionalDigits": 2,
      "currencyCode": "USD",
      "numericCode": "840"
    },
    "id": "UsDollar",
    "locale": "en_US",
    "shippingSurchargePriceList": {"repositoryId": "shippingSurchargePrices"},
    "includeAllProducts": true
  },
  "sort": [{
    "property": "displayName",
    "order": "asc"
  }],
  "items": [
    {
      "displayName": null,
      "listPriceList": {"repositoryId": "listPrices"},
      "repositoryId": "UsDollar",
      "active": false,
      "salePriceList": {"repositoryId": "salePrices"},
      "currency": {
        "symbol": "$",
        "displayName": "US Dollar",
        "repositoryId": "en_US",
        "fractionalDigits": 2,
        "currencyCode": "USD",
        "numericCode": "840"
      },
      "id": "UsDollar",
      "locale": "en_US",
      "shippingSurchargePriceList": {"repositoryId": "shippingSurcharge"},
      "includeAllProducts": true
    },
    {
      "displayName": "CanadianDollar",
      "listPriceList": {"repositoryId": "CanadianDollar_listPrice"},
      "repositoryId": "CanadianDollar",
      "active": false,
      "salePriceList": {"repositoryId": "CanadianDollar_salePrice"},
      "id": "CanadianDollar",
      "locale": "en_CA",
      "shippingSurchargePriceList": {"repositoryId": "CanadianDollar_shippingSurchargePrice"},
      "includeAllProducts": false
    }
  ]
}