getAllPrices
get
/ccagent/v1/prices/{id}
Get All Prices. Return the the list and sale price for the product or SKU. This Endpoint is clone of StoreFront endpoint and it can be used if application running on agent/admin server need access the product prices data configured for StoreFront. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile.Additonally takes x-ccsite header to return the data specific to the site.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The product ID.
Query Parameters
-
showInactiveSkus(optional): boolean
If it is false inactive skus will not be considered for calculating price range.
Header Parameters
-
x-ccsite(optional): string
the site id on which the orders is laced
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAllPrices_response
Type:
Show Source
object
-
If the returned type is a product or default(optional):
object If the returned type is a product or default
Result object having product related information.
-
If the returned type is a sku.(optional):
object If the returned type is a sku.
Result object having SKU related information.
Nested Schema : If the returned type is a product or default
Type:
object
Result object having product related information.
Show Source
-
list(optional):
number
The list price of the product.
-
priceRange(optional):
boolean
Whether the price is a range.
-
skuPrices(optional):
array skuPrices
The array of SKU data.
Nested Schema : If the returned type is a sku.
Type:
object
Result object having SKU related information.
Show Source
-
list(optional):
number
The list price of the product (if type is selected as list).
-
sale(optional):
number
The sale price of the product (if type is selected as sale and sale price exists).
Nested Schema : items
Type:
Show Source
object
-
complexPrice(optional):
object complexPrice
The complex price of the SKU.
-
listPrice(optional):
number
The list price of the SKU.
-
salePrice(optional):
number
The sale price of the SKU.
-
skuId(optional):
string
SKU ID.
Nested Schema : complexPrice
Type:
object
The complex price of the SKU.
Show Source
-
levels(optional):
array levels
Price levels of the Complex price.
Nested Schema : items
Type:
Show Source
object
-
levelMaximum(optional):
number
The maximum quantity associated with this level.
-
levelMinimum(optional):
number
The minimum quantity associated with this level.
-
price(optional):
number
The price associated with this level.
Example Response (application/json)
{
"priceMin":596,
"priceMax":599,
"skuPrices":[
{
"salePrice":599,
"skuId":"camcordersku_1_1",
"listPrice":699.99
},
{
"salePrice":596,
"skuId":"camcordersku_1_2",
"listPrice":699.99
},
{
"salePrice":597,
"skuId":"camcordersku_1_3",
"listPrice":699.99
},
{
"salePrice":598,
"skuId":"camcordersku_1_4",
"listPrice":699.99
}
],
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstore/v1/prices/camcorder_1"
}
],
"priceRange":true
}
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|
|------------------|------------------|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|20031|Product Id prod10007 is invalid or non-existent.|
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