listPriceListGroups
get
/ccadmin/v1/priceListGroups
List Price List Groups. Get a list of PriceListGroups.
Request
Supported Media Types
- application/json
Query Parameters
-
active(optional): boolean
If true, return only actives price list groups. If false or not present, returns inactive price list groups.
-
defaultFirst(optional): boolean
This for displaying default PriceListGroup first in the list
-
includeAncestors(optional): boolean
If true, returns PriceListGroup's ancestor information in the response. Default is false.
-
includeDeleted(optional): boolean
If true, include soft deleted items in results. If false or not present, exclude them.
-
limit(optional): integer
The number of items to return.
-
offset(optional): integer
Index of the first element to return.
-
q(optional): string
The search query string in SCIM format. Results will be filtered based on this query.
-
showAccessControlInfo(optional): boolean
Boolean flag to determine whether to show currently logged in user's access control information for the priceListGroups in the response. Default value is false.
-
siteId(optional): string
Site ID of the site
-
sort(optional): string
Sorting criteria.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listPriceListGroups_response
Type:
Show Source
object
-
defaultPriceListGroup(optional):
object defaultPriceListGroup
The default Price List Group
-
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 : defaultPriceListGroup
Type:
object
The default Price List Group
Show Source
-
active(optional):
boolean
indicates if the PriceListGroup is active
-
ancestorPriceListGroups(optional):
array ancestorPriceListGroups
Array of ancestor price list group ids (if any) for this price list group.
-
basePriceListGroup(optional):
object basePriceListGroup
The base price list group of this price list group.
-
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
-
id(optional):
string
The ID of the PriceListGroup item
-
includeAllProducts(optional):
boolean
If true, indicates that all the products in the catalog should have prices for activation of the PLG
-
isPointsBased(optional):
boolean
If true, indicates the PriceListGroup was created with a point based currency
-
isTaxIncluded(optional):
boolean
Indicates whether prices are inclusive of tax
-
listPriceList(optional):
object listPriceList
The price list for list prices
-
locale(optional):
string
The locale
-
repositoryId(optional):
string
The repository 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
-
taxCalculationType(optional):
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 : ancestorPriceListGroups
Type:
array
Array of ancestor price list group ids (if any) for this price list group.
Show Source
Nested Schema : basePriceListGroup
Type:
object
The base price list group of this price list group.
Show Source
-
id(optional):
string
Repository ID of the base price list group.
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
The currency Code of the currency
-
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
Nested Schema : salePriceList
Type:
object
The price list for sale prices
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : shippingSurchargePriceList
Type:
object
The price list for shipping surcharge prices
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
indicates if the PriceListGroup is active
-
ancestorPriceListGroups(optional):
array ancestorPriceListGroups
Array of ancestor price list group ids (if any) for this price list group.
-
basePriceListGroup(optional):
object basePriceListGroup
The base price list group of this price list group.
-
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
-
id(optional):
string
The ID of the PriceListGroup item
-
includeAllProducts(optional):
boolean
If true, indicates that all the products in the catalog should have prices for activation of the PLG
-
isTaxIncluded(optional):
boolean
Indicates whether prices are inclusive of tax.
-
listPriceList(optional):
object listPriceList
The price list for list prices
-
locale(optional):
string
The locale with which the PriceListGroup is created
-
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 : ancestorPriceListGroups
Type:
array
Array of ancestor price list group ids (if any) for this price list group.
Show Source
Nested Schema : basePriceListGroup
Type:
object
The base price list group of this price list group.
Show Source
-
displayName(optional):
string
Name of the base price list group.
-
id(optional):
string
Repository ID of the base price list group.
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
The currency Code of the currency
-
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
Nested Schema : salePriceList
Type:
object
The price list for sale prices
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : shippingSurchargePriceList
Type:
object
The price list for shipping surcharge prices
Show Source
-
repositoryId(optional):
string
Repository ID
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":{
"isTaxIncluded":false,
"endDate":"2016-03-11T18:30:00.000Z",
"displayName":"UsDollar",
"listPriceList":{
"repositoryId":"listPrices"
},
"active":false,
"isPointsBased":false,
"locale":"en_US",
"basePriceListGroup":null,
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
},
"taxCalculationType":"calculateTax",
"ancestorPriceListGroups":[
],
"repositoryId":"UsDollar",
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"symbol":"$",
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"UsDollar",
"includeAllProducts":true,
"startDate":"2016-03-10T18:30:00.000Z"
},
"sort":[
{
"property":"displayName",
"order":"asc"
}
],
"items":[
{
"endDate":"2016-03-11T18:30:00.000Z",
"displayName":null,
"listPriceList":{
"repositoryId":"listPrices"
},
"active":false,
"isPointsBased":false,
"locale":"en_US",
"basePriceListGroup":null,
"shippingSurchargePriceList":null,
"taxCalculationType":"calculateTax",
"ancestorPriceListGroups":[
],
"repositoryId":"UsDollar",
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"symbol":"$",
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"UsDollar",
"includeAllProducts":true,
"startDate":"2016-03-10T18:30:00.000Z"
},
{
"isTaxIncluded":false,
"endDate":"2016-03-11T18:30:00.000Z",
"displayName":"CanadianDollar",
"listPriceList":{
"repositoryId":"CanadianDollar_listPrice"
},
"active":false,
"isPointsBased":false,
"basePriceListGroup":{
"displayName":"Canadian Dollar Sale",
"id":"canadianDollarSale"
},
"locale":"en_CA",
"shippingSurchargePriceList":{
"repositoryId":"CanadianDollar_shippingSurchargePrice"
},
"taxCalculationType":"calculateTax",
"ancestorPriceListGroups":[
"canadianDollarSale",
"canadianDollarRoot"
],
"repositoryId":"CanadianDollar",
"salePriceList":{
"repositoryId":"CanadianDollar_salePrice"
},
"id":"CanadianDollar",
"includeAllProducts":false,
"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|
|------------------|------------------|
|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