listPriceListGroups
get
/ccstore/v1/priceListGroups
List Price List Groups. Get a list of PriceListGroups.
Request
Supported Media Types
- application/json
Query Parameters
-
defaultFirst(optional): boolean
This for displaying default PriceListGroup first in the list
-
limit(optional): integer
The number of items to return.
-
offset(optional): integer
Index of the first element to return.
-
siteId(optional): string
Site ID of the site
-
sort(optional): string
Sorting criteria. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |property|string|The property the listing is sorted by.| |order|string|Sort order: asc or desc.|
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listPriceListGroups_response
Type:
Show Source
object
-
items(optional):
array items
List of PriceListGroups
-
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
-
active(optional):
boolean
indicates if the PriceListGroup is activ.e
-
displayName(optional):
string
display name of the PriceListGroup.
-
includeAllProducts(optional):
boolean
If true, and active flag is also set to true then list price is mandatory for all products.
-
listPriceList(optional):
object listPriceList
Price List for list prices
-
repositoryId(optional):
string
The ID of the PriceListGroup item.
-
salePriceList(optional):
object salePriceList
Price List for sale prices.
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
Price List for shipping surcharge prices.
Nested Schema : listPriceList
Type:
object
Price List for list prices
Show Source
-
repositoryId(optional):
string
Repository ID of the list prices.
Nested Schema : salePriceList
Type:
object
Price List for sale prices.
Show Source
-
repositoryId(optional):
string
Repository ID of the sale prices.
Nested Schema : shippingSurchargePriceList
Type:
object
Price List for shipping surcharge prices.
Show Source
-
repositoryId(optional):
string
Repository ID of the shipping surcharge prices.
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,
"defaultPriceListGroup":{
"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"
},
"includeAllProducts":true
},
"sort":[
{
"property":"displayName",
"order":"asc"
}
],
"items":[
{
"displayName":null,
"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":"shippingSurcharge"
},
"includeAllProducts":true
},
{
"displayName":"CanadianDollar",
"listPriceList":{
"repositoryId":"CanadianDollar_listPrice"
},
"repositoryId":"CanadianDollar",
"active":false,
"salePriceList":{
"repositoryId":"CanadianDollar_salePrice"
},
"id":"CanadianDollar",
"locale":"en_CA",
"shippingSurchargePriceList":{
"repositoryId":"CanadianDollar_shippingSurchargePrice"
},
"includeAllProducts":false
}
]
}
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|
|------------------|------------------|
|20185|There was an error fetching the PriceListGroup list.|
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