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: integer
The number of items to return.
-
offset: integer
Index of the first element to return.
-
priceListGroupId(required): string
The price list group id for which the prices have to be returned.
-
sort: 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:
array items
List of Prices
-
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:
Show Source
object
-
endDate:
string
End date of a price
-
listPrice:
number
List price
-
parentSkuId:
string
Parent Sku Id
-
priceList:
object priceList
The price list for this price
-
pricingScheme:
string
Pricing Scheme
-
productId:
string
Product Id
-
repositoryId:
string
Repository Id
-
skuId:
string
Sku Id
-
startDate:
string
Start date of a price
-
volumePrice:
object volumePrice
Volume price
Nested Schema : priceList
Type:
object
The price list for this price
Show Source
-
repositoryId:
string
Repository ID
Nested Schema : volumePrice
Type:
object
Volume price
Show Source
-
levels:
array levels
Levels
-
repositoryId:
string
Repository Id
Nested Schema : items
Type:
Show Source
object
-
price:
number
Price for this level
-
quantity:
integer
Minimum Quantity for this level
-
repositoryId:
string
Repository Id
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":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:
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:
array
An 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