listPriceListGroups
get
/ccstore/v1/priceListGroups
List Price List Groups. Get a list of PriceListGroups.
Request
Supported Media Types
- application/json
Query Parameters
-
defaultFirst: boolean
This for displaying default PriceListGroup first in the list
-
limit: integer
The number of items to return.
-
offset: integer
Index of the first element to return.
-
siteId: string
Site ID of the site
-
sort: 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-
defaultPriceListGroup:
object defaultPriceListGroup
The default Price List Group
-
items:
array items
List of PriceListGroups
-
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 : defaultPriceListGroup
Type:
objectThe default Price List Group
Show Source
-
active:
boolean
indicates if the PriceListGroup is active
-
currency:
object currency
The currency data.
-
deleted:
boolean
indicates if the PriceListGroup is deleted
-
displayName:
string
display name of the PriceListGroup
-
endDate:
string
End date of the the associated list price list
-
id:
string
The ID of the PriceListGroup item
-
includeAllProducts:
boolean
If true, indicates that all the products in the catalog should have prices for activation of the PLG
-
isPointsBased:
boolean
If true, indicates the PriceListGroup was created with a point based currency
-
isTaxIncluded:
boolean
Indicates whether prices are inclusive of tax
-
listPriceList:
object listPriceList
The price list for list prices
-
locale:
string
The locale
-
repositoryId:
string
The repository Id of the PriceListGroup item
-
salePriceList:
object salePriceList
The price list for sale prices
-
shippingSurchargePriceList:
object shippingSurchargePriceList
The price list for shipping surcharge prices
-
startDate:
string
Start date of the the associated list price list
-
taxCalculationType:
string
Indicates how tax calls are made based on the PriceListGroup setting. For a monetary PriceListGroup, the possible values are calculateTax and doNotCalculateTax. For a point based PriceListGroup, the possible values are doNotCalculateTax, calculateTaxWithCurrencyConversion and calculateTaxWithoutCurrencyConversion.
Nested Schema : currency
Type:
objectThe currency data.
Show Source
-
currencyCode:
string
The currency Code of the currency
-
displayName:
string
The display Name of the currency
-
fractionalDigits:
string
The currency Code of the currency
-
numericCode:
string
The numeric Code of the currency
-
repositoryId:
string
The repository Id of the currency
-
symbol:
string
The symbol of the currency
Nested Schema : listPriceList
Type:
objectThe price list for list prices
Show Source
-
repositoryId:
string
Repository ID
Nested Schema : salePriceList
Type:
objectThe price list for sale prices
Show Source
-
repositoryId:
string
Repository ID
Nested Schema : shippingSurchargePriceList
Type:
objectThe price list for shipping surcharge prices
Show Source
-
repositoryId:
string
Repository ID
Nested Schema : items
Type:
Show Source
object-
active:
boolean
indicates if the PriceListGroup is active
-
currency:
object currency
The currency data.
-
deleted:
boolean
indicates if the PriceListGroup is deleted
-
displayName:
string
display name of the PriceListGroup
-
endDate:
string
End date of the the associated list price list
-
id:
string
The ID of the PriceListGroup item
-
includeAllProducts:
boolean
If true, indicates that all the products in the catalog should have prices for activation of the PLG
-
isTaxIncluded:
boolean
Indicates whether prices are inclusive of tax.
-
listPriceList:
object listPriceList
The price list for list prices
-
locale:
string
The locale with which the PriceListGroup is created
-
repositoryId:
string
The ID of the PriceListGroup item
-
salePriceList:
object salePriceList
The price list for sale prices
-
shippingSurchargePriceList:
object shippingSurchargePriceList
The price list for shipping surcharge prices
-
startDate:
string
Start date of the the associated list price list
Nested Schema : currency
Type:
objectThe currency data.
Show Source
-
currencyCode:
string
The currency Code of the currency
-
displayName:
string
The display Name of the currency
-
fractionalDigits:
string
The currency Code of the currency
-
numericCode:
string
The numeric Code of the currency
-
repositoryId:
string
The repository Id of the currency
-
symbol:
string
The symbol of the currency
Nested Schema : listPriceList
Type:
objectThe price list for list prices
Show Source
-
repositoryId:
string
Repository ID
Nested Schema : salePriceList
Type:
objectThe price list for sale prices
Show Source
-
repositoryId:
string
Repository ID
Nested Schema : shippingSurchargePriceList
Type:
objectThe price list for shipping surcharge prices
Show Source
-
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,
"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:
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:
arrayAn 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