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
- application/json
Query Parameters
-
includeAncestors: boolean
If true, returns PriceListGroup's ancestor information in the response. Default is false.
Header Parameters
-
X-CCAsset-Language(required): string
The asset language of the request
Root Schema : listPriceListGroupsWithPrices_request
Type:
Show Source
object-
active:
boolean
If null, don't filter active/inactive items. If true or false, return only items where active has that value.
-
includeAncestors:
boolean
If true, returns PriceListGroup's ancestor information in the response. Default is false.
-
includeChildSKUsPrices:
boolean
If true, includes child skus prices inside the product. If false or not present, exclude them.
-
includeDeleted:
boolean
If true, include soft deleted items in results. If false or not present, exclude them.
-
limit:
integer
The number of items to return.
-
offset:
integer
Index of the first element to return.
-
productId(required):
string
Product ID for which prices have to be fetched. Either one of product id or sku id is required.
-
q:
string
The search query string in SCIM format. Results will be filtered based on this query.
-
showAccessControlInfo:
boolean
Boolean flag to determine whether to show currently logged in user's access control information for the priceListGroups in the response. Default value is false.
-
siteId:
string
The site ID.
-
skuId(required):
string
Sku ID for which prices have to be fetched. Either one of product id or sku id is required.
-
sort:
array sort
Sorting criteria.
Example:
{
"q":"id co \"new\" or displayName co \"new\" ",
"showAccessControlInfo":true,
"offset":0,
"limit":40,
"sort":"displayName:asc",
"skuId":"sku30003",
"includeAncestors":"true"
}Nested Schema : items
Type:
Show Source
object-
order:
string
Sort order: asc or desc.
-
property:
string
The property the listing is sorted by.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listPriceListGroupsWithPrices_response
Type:
Show Source
object-
items:
array items
List of custom price objects containing PriceListGroup and product/sku's price.
-
limit:
integer
The number of items to return.
-
offset:
integer
Index of the first element to return.
-
sort:
array sort
Sorting criteria.
-
total:
integer
The total number of items. Deprecated.
-
totalResults:
integer
The total number of items.
Nested Schema : items
Type:
arrayList of custom price objects containing PriceListGroup and product/sku's price.
Show Source
Nested Schema : items
Type:
Show Source
object-
priceListGroup:
object priceListGroup
The PriceListGroup object
-
product:
object product
Product prices
Nested Schema : priceListGroup
Type:
objectThe PriceListGroup object
Show Source
-
active:
boolean
indicates if the PriceListGroup is active
-
ancestorPriceListGroups:
array ancestorPriceListGroups
Array of ancestor price list group ids (if any) for this price list group.
-
basePriceListGroup:
object basePriceListGroup
The base price list group of this price list group.
-
currency:
object currency
The currency data.
-
deleted:
boolean
indicates if the PriceListGroup is deleted
-
displayName:
string
display name of the PriceListGroup
-
endDate:
string
End date of the the associated list price list
-
id:
string
The ID of the PriceListGroup item
-
includeAllProducts:
boolean
If true, indicates that all the products in the catalog should have prices for activation of the PLG
-
isTaxIncluded:
boolean
Indicates whether prices are inclusive of tax.
-
listPriceList:
object listPriceList
The price list for list prices
-
locale:
string
The locale
-
repositoryId:
string
The repository Id of the PriceListGroup item
-
salePriceList:
object salePriceList
The price list for sale prices
-
shippingSurchargePriceList:
object shippingSurchargePriceList
The price list for shipping surcharge prices
-
startDate:
string
Start date of the the associated list price list
Nested Schema : product
Type:
objectProduct prices
Show Source
-
childSKUs:
array childSKUs
List of child skus' prices
-
derivedListPriceFrom:
string
Determines from which price list group, list price is derived. It can be either current price list group or one of it's ancestors
-
derivedSalePriceFrom:
string
Determines from which price list group, sale price is derived. It can be either current price list group or one of it's ancestors
-
derivedShippingSurchargeFrom:
string
Determines from which price list group, shipping surcharge is derived. It can be either current price list group or one of it's ancestors
-
id:
string
Product repository id.
-
listPrice:
number
List Price of the product.
-
listVolumePrice:
object listVolumePrice
List Volume price of the product
-
salePrice:
string
Sale Price of product.
-
saleVolumePrice:
object saleVolumePrice
Sale Volume price of the product
-
shippingSurcharge:
number
Shipping surcharge of the product.
Nested Schema : ancestorPriceListGroups
Type:
arrayArray of ancestor price list group ids (if any) for this price list group.
Show Source
Nested Schema : basePriceListGroup
Type:
objectThe base price list group of this price list group.
Show Source
-
id:
string
Repository ID of the base price list group.
Nested Schema : currency
Type:
objectThe currency data.
Show Source
-
currencyCode:
string
The currency Code of the currency
-
displayName:
string
The display Name of the currency
-
fractionalDigits:
string
The currency Code of the currency
-
numericCode:
string
The numeric Code of the currency
-
repositoryId:
string
The repository Id of the currency
-
symbol:
string
The symbol of the currency
Nested Schema : listPriceList
Type:
objectThe price list for list prices
Show Source
-
repositoryId:
string
Repository ID
Nested Schema : salePriceList
Type:
objectThe price list for sale prices
Show Source
-
repositoryId:
string
Repository ID
Nested Schema : shippingSurchargePriceList
Type:
objectThe price list for shipping surcharge prices
Show Source
-
repositoryId:
string
Repository ID
Nested Schema : listVolumePrice
Type:
objectList Volume price of the product
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrice
Type:
objectSale Volume price of the product
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : items
Type:
Show Source
object-
derivedListPriceFrom:
string
Determines from which price list group, list price is derived. It can be either current price list group or one of it's ancestors
-
derivedSalePriceFrom:
string
Determines from which price list group, sale price is derived. It can be either current price list group or one of it's ancestors
-
derivedShippingSurchargeFrom:
string
Determines from which price list group, shipping surcharge is derived. It can be either current price list group or one of it's ancestors
-
id:
string
SKU repository id.
-
listPrice:
string
List Price of the SKU.
-
listVolumePrice:
object listVolumePrice
List Volume price of the SKU
-
salePrice:
string
Sale Price of SKU.
-
saleVolumePrice:
object saleVolumePrice
Sale Volume price of the SKU
-
shippingSurcharge:
number
Extra handling costs while shipping the product, in the default price group.
Nested Schema : listVolumePrice
Type:
objectList Volume price of the SKU
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : saleVolumePrice
Type:
objectSale Volume price of the SKU
Show Source
-
pricingScheme:
object pricingScheme
Pricing scheme can be either tieredPrice or bulkPrice
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(required):
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum(required):
number
minimum quantity for price level
-
price(required):
number
price value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(required):
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum(required):
number
minimum quantity for price level
-
price(required):
number
price value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(required):
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum(required):
number
minimum quantity for price level
-
price(required):
number
price value for price level
Nested Schema : pricingScheme
Type:
objectPricing scheme can be either tieredPrice or bulkPrice
Show Source
-
levels(required):
array levels
Price levels array for volume price
-
numLevels:
number
Number of levels in the volume price
Nested Schema : items
Type:
Show Source
object-
levelMaximum:
number
minimum quantity for price level
-
levelMinimum(required):
number
minimum quantity for price level
-
price(required):
number
price value for price level
Nested Schema : items
Type:
Show Source
object-
order:
string
Sort order: asc or desc.
-
property:
string
The property the listing is sorted by.
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,
"derivedShippingSurchargeFrom":"UsDollar",
"salePrice":null,
"derivedSalePriceFrom":"UsDollar",
"derivedListPriceFrom":"UsDollar",
"shippingSurcharge":null,
"id":"sku30003",
"listPrice":55
}
],
"listVolumePrice":50,
"derivedShippingSurchargeFrom":"UsDollar",
"salePrice":40,
"derivedSalePriceFrom":"UsDollar",
"derivedListPriceFrom":"UsDollar",
"shippingSurcharge":null,
"id":"prod10001",
"listPrice":null
},
"priceListGroup":{
"isTaxIncluded":false,
"endDate":null,
"displayName":"A new B2C",
"listPriceList":{
"repositoryId":"aNewB2C_listPrices"
},
"active":false,
"locale":"en_US",
"basePriceListGroup":null,
"shippingSurchargePriceList":{
"repositoryId":"aNewB2C_shippingSurchargePrices"
},
"deleted":false,
"ancestorPriceListGroups":[
],
"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,
"derivedSalePriceFrom":"UsDollar",
"derivedListPriceFrom":"UsDollar",
"id":"sku30003",
"listPrice":null
}
],
"listVolumePrice":null,
"derivedShippingSurchargeFrom":"UsDollar",
"salePrice":null,
"derivedSalePriceFrom":"UsDollar",
"derivedListPriceFrom":"UsDollar",
"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",
"basePriceListGroup":{
"displayName":"USD Parent",
"id":"USDParent"
},
"shippingSurchargePriceList":{
"repositoryId":"newB2BInactive_shippingSurchargePrices"
},
"deleted":false,
"ancestorPriceListGroups":[
"USDParent",
"rootPriceListGroup"
],
"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.|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code