getPriceListGroup
get
/ccstore/v1/priceListGroups/{id}
Get Price List Group. Get a single PriceListGroup item.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the requested PriceListGroup.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPriceListGroup_response
Type:
Show Source
object
-
active(optional):
boolean
Indicates if the PriceListGroup is active.
-
currency(optional):
object currency
The currency data.
-
deleted(optional):
boolean
Indicates if the PriceListGroup is deleted.
-
displayName(optional):
string
Display name of the PriceListGroup.
-
endDate(optional):
string
End date of the the associated list price list.
-
listPriceList(optional):
object listPriceList
The price list for list prices
-
locale(optional):
string
Locale of the the associated list price list.
-
repositoryId(optional):
string
The ID of the PriceListGroup item.
-
salePriceList(optional):
object salePriceList
The price list for sale prices.
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
The price list for shipping surcharge prices.
-
startDate(optional):
string
Start date of the the associated list price list.
Nested Schema : currency
Type:
object
The currency data.
Show Source
-
currencyCode(optional):
string
The currency Code of the currency.
-
displayName(optional):
string
The display Name of the currency.
-
fractionalDigits(optional):
string
Fractional digits that currency supports.
-
numericCode(optional):
string
The numeric Code of the currency.
-
repositoryId(optional):
string
The repository id of the currency.
-
symbol(optional):
string
The symbol of the currency.
Nested Schema : listPriceList
Type:
object
The price list for list prices
Show Source
-
repositoryId(optional):
string
Repository id of the list price list.
Nested Schema : salePriceList
Type:
object
The price list for sale prices.
Show Source
-
repositoryId(optional):
string
Repository id of the sale price list.
Nested Schema : shippingSurchargePriceList
Type:
object
The price list for shipping surcharge prices.
Show Source
-
repositoryId(optional):
string
Repository id of shipping surcharge price list.
Example Response (application/json)
{
"deleted":false,
"endDate":"2016-03-11T18:30:00.000Z",
"displayName":"UsDollar",
"listPriceList":{
"repositoryId":"listPrices"
},
"repositoryId":"UsDollar",
"active":false,
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"symbol":"$",
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"UsDollar",
"locale":"en_US",
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
},
"startDate":"2016-03-10T18:30:00.000Z"
}
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|
|------------------|------------------|
|20187|No PriceListGroup found for the id : invalidId|
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