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(optional): integer
The number of items to return.
-
offset(optional): integer
Index of the first element to return.
-
priceListGroupId: string
The price list group id for which the prices have to be returned.
-
sort(optional): string
Sorting criteria.
Response
Supported Media Types
- application/json
200 Response
The following model is returned if the operation succeeds.
Root Schema : listPrices_response
Type:
Show Source
object
-
items(optional):
array items
List of Prices
-
limit(optional):
integer
The number of items to return.
-
offset(optional):
integer
Index of the first element to return.
-
sort(optional):
array sort
Sorting criteria.
-
total(optional):
integer
The total number of items. Deprecated.
-
totalResults(optional):
integer
The total number of items.
Nested Schema : items
Type:
Show Source
object
-
endDate(optional):
string
End date of a price
-
listPrice(optional):
number
List price
-
parentSkuId(optional):
string
Parent Sku Id
-
priceList(optional):
object priceList
The price list for this price
-
pricingScheme(optional):
string
Pricing Scheme
-
productId(optional):
string
Product Id
-
repositoryId(optional):
string
Repository Id
-
skuId(optional):
string
Sku Id
-
startDate(optional):
string
Start date of a price
-
volumePrice(optional):
object volumePrice
Volume price
Nested Schema : priceList
Type:
object
The price list for this price
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : volumePrice
Type:
object
Volume price
Show Source
-
levels(optional):
array levels
Levels
-
repositoryId(optional):
string
Repository Id
Nested Schema : items
Type:
Show Source
object
-
price(optional):
number
Price for this level
-
quantity(optional):
integer
Minimum Quantity for this level
-
repositoryId(optional):
string
Repository Id
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Sort order: asc or desc.
-
property(optional):
string
The property the listing is sorted by.
Example Response (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.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code