listPriceListGroupsWithPrices

post

/ccadmin/v1/priceListGroups/listWithPrices

List Price List Groups With Prices. Returns a list of PriceListGroups along with price information of a given product or sku.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : listPriceListGroupsWithPrices_request
Type: object
Show Source
Example:
{
    "q":"id co \"new\" or displayName co \"new\" ",
    "offset":0,
    "limit":40,
    "sort":"displayName:asc",
    "skuId":"sku30003"
}
Nested Schema : sort
Type: array
Sorting criteria.
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listPriceListGroupsWithPrices_response
Type: object
Show Source
Nested Schema : items
Type: array
List of custom price objects containing PriceListGroup and product/sku's price.
Show Source
Nested Schema : sort
Type: array
Sorting criteria.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : priceListGroup
Type: object
The PriceListGroup object
Show Source
Nested Schema : product
Type: object
Product prices
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 : childSKUs
Type: array
List of child skus' prices
Show Source
Nested Schema : listVolumePrice
Type: object
List Volume price of the product
Show Source
Nested Schema : saleVolumePrice
Type: object
Sale Volume price of the product
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : listVolumePrice
Type: object
List Volume price of the SKU
Show Source
Nested Schema : saleVolumePrice
Type: object
Sale Volume price of the SKU
Show Source
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
Nested Schema : levels
Type: array
Price levels array for volume price
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
Nested Schema : levels
Type: array
Price levels array for volume price
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
Nested Schema : levels
Type: array
Price levels array for volume price
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : pricingScheme
Type: object
Pricing scheme can be either tieredPrice or bulkPrice
Show Source
Nested Schema : levels
Type: array
Price levels array for volume price
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":40,
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "product":{
                "saleVolumePrice":null,
                "childSKUs":[
                    {
                        "saleVolumePrice":null,
                        "listVolumePrice":null,
                        "salePrice":null,
                        "id":"sku30003",
                        "listPrice":55
                    }
                ],
                "listVolumePrice":50,
                "salePrice":40,
                "shippingSurcharge":null,
                "id":"prod10001",
                "listPrice":null
            },
            "priceListGroup":{
                "isTaxIncluded":false,
                "endDate":null,
                "displayName":"A new B2C",
                "listPriceList":{
                    "repositoryId":"aNewB2C_listPrices"
                },
                "active":false,
                "locale":"en_US",
                "shippingSurchargePriceList":{
                    "repositoryId":"aNewB2C_shippingSurchargePrices"
                },
                "deleted":false,
                "repositoryId":"aNewB2C",
                "salePriceList":{
                    "repositoryId":"aNewB2C_salePrices"
                },
                "currency":{
                    "symbol":"$",
                    "displayName":"US Dollar",
                    "repositoryId":"en_US",
                    "fractionalDigits":2,
                    "currencyCode":"USD",
                    "numericCode":"840"
                },
                "id":"aNewB2C",
                "includeAllProducts":true,
                "startDate":null
            }
        },
        {
            "product":{
                "saleVolumePrice":null,
                "childSKUs":[
                    {
                        "saleVolumePrice":null,
                        "listVolumePrice":null,
                        "salePrice":null,
                        "id":"sku30003",
                        "listPrice":null
                    }
                ],
                "listVolumePrice":null,
                "salePrice":null,
                "shippingSurcharge":null,
                "id":"prod10001",
                "listPrice":90
            },
            "priceListGroup":{
                "isTaxIncluded":false,
                "endDate":null,
                "displayName":"New B2B A Inactive",
                "listPriceList":{
                    "repositoryId":"newB2BInactive_listPrices"
                },
                "active":false,
                "locale":"en_US",
                "shippingSurchargePriceList":{
                    "repositoryId":"newB2BInactive_shippingSurchargePrices"
                },
                "deleted":false,
                "repositoryId":"newB2BInactive",
                "salePriceList":{
                    "repositoryId":"newB2BInactive_salePrices"
                },
                "currency":{
                    "symbol":"$",
                    "displayName":"US Dollar",
                    "repositoryId":"en_US",
                    "fractionalDigits":2,
                    "currencyCode":"USD",
                    "numericCode":"840"
                },
                "id":"newB2BInactive",
                "includeAllProducts":false,
                "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| |------------------|------------------| |100177|Either one of the product ID or sku ID is required.|
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