1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Prices

listPrices

get

/ccadmin/v1/prices

List Prices. Returns a list of lisPrices, salePrices and shippingSurchargePrices for a specific priceListGroupId.

Request

Supported Media Types
  • application/json
Query Parameters
limit
Type: integer
The number of items to return.
offset
Type: integer
Index of the first element to return.
priceListGroupId
Type: string
Required: true
The price list group id for which the prices have to be returned.
sort
Type: string
Sorting criteria.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listPrices_response
Nested Schema : items
Type: array
List of Prices
Nested Schema : sort
Type: array
Sorting criteria.
Nested Schema : items
Type: object
Nested Schema : priceList
Type: object
The price list for this price
Nested Schema : volumePrice
Type: object
Volume price
Nested Schema : levels
Type: array
Levels
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":250,
    "sort":[
        {
            "property":"priceList",
            "order":"asc"
        }
    ],
    "items":[
        {
            "productId":"Product_13CD",
            "endDate":null,
            "pricingScheme":"listPrice",
            "volumePrice":null,
            "repositoryId":"p121007",
            "parentSkuId":null,
            "startDate":null,
            "listPrice":2,
            "skuId":null,
            "priceList":{
                "repositoryId":"new1_listPrices"
            }
        },
        {
            "productId":"Product_13CD",
            "endDate":null,
            "pricingScheme":"bulkPrice",
            "volumePrice":{
                "repositoryId":"cxp10003",
                "levels":[
                    {
                        "quantity":1,
                        "price":25,
                        "repositoryId":"plvl10003"
                    },
                    {
                        "quantity":5,
                        "price":20,
                        "repositoryId":"plvl10004"
                    }
                ]
            },
            "repositoryId":"p141006",
            "parentSkuId":null,
            "startDate":null,
            "listPrice":null,
            "skuId":"Sku_13DE",
            "priceList":{
                "repositoryId":"new1_listPrices"
            }
        }
    ]
}
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| |------------------|------------------| |100177|Error getting prices.|
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,
  "sort": [{
    "property": "priceList",
    "order": "asc"
  }],
  "items": [
    {
      "productId": "Product_13CD",
      "endDate": null,
      "pricingScheme": "listPrice",
      "volumePrice": null,
      "repositoryId": "p121007",
      "parentSkuId": null,
      "startDate": null,
      "listPrice": 2,
      "skuId": null,
      "priceList": {"repositoryId": "new1_listPrices"}
    },
    {
      "productId": "Product_13CD",
      "endDate": null,
      "pricingScheme": "bulkPrice",
      "volumePrice": {
        "repositoryId": "cxp10003",
        "levels": [
          {
            "quantity": 1,
            "price": 25,
            "repositoryId": "plvl10003"
          },
          {
            "quantity": 5,
            "price": 20,
            "repositoryId": "plvl10004"
          }
        ]
      },
      "repositoryId": "p141006",
      "parentSkuId": null,
      "startDate": null,
      "listPrice": null,
      "skuId": "Sku_13DE",
      "priceList": {"repositoryId": "new1_listPrices"}
    }
  ]
}