listCurrencies
get
/ccagent/v1/currencies
List Currencies. Get a list of currencies and the currently selected currency.
Request
Supported Media Types
- application/json
Query Parameters
-
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.
-
sort(optional): string
Sorting criteria.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listCurrencies_response
Type:
Show Source
object
-
items(optional):
array items
List of currencies
-
limit(optional):
integer
The number of items to return.
-
offset(optional):
integer
Index of the first element to return.
-
selectedCurrency(optional):
object selectedCurrency
Selected currency
-
sort(optional):
array sort
Sorting criteria.
-
total(optional):
integer
The total number of items. Deprecated.
-
totalResults(optional):
integer
The total number of items.
-
type(optional):
string
The promotion type being listed.
Nested Schema : selectedCurrency
Type:
object
Selected currency
Show Source
-
currencyCode(optional):
string
currency code of Currency
-
currencyType(optional):
string
Type of Currency
-
deleted(optional):
string
deleted flag of currency. Applicable to loylatyPoints currencyType.
-
displayName(optional):
string
Readable name of the currency
-
fractionalDigits(optional):
integer
Number of digits to the right of the decimal point
-
numericCode(optional):
string
numeric currency code
-
repositoryId(optional):
string
The ID of the currency item, which is a locale string.
-
symbol(optional):
string
The currency symbol
Nested Schema : items
Type:
Show Source
object
-
currencyCode(optional):
string
currency code of currency
-
currencyType(optional):
string
Type of Currency
-
deleted(optional):
string
deleted flag of currency. Applicable to loylatyPoints currencyType.
-
displayName(optional):
string
Readable name of the currency
-
fractionalDigits(optional):
string
Number of digits to the right of the decimal point
-
numericCode(optional):
string
numeric currency code
-
repositoryId(optional):
string
The ID of the currency item, which is a locale string.
-
symbol(optional):
string
The currency symbol
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":43,
"totalResults":43,
"offset":3,
"selectedCurrency":{
"currencyType":null,
"symbol":"$",
"deleted":false,
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"limit":3,
"sort":{
"property":"currencyCode",
"order":"asc"
},
"items":{
"currencyType":null,
"symbol":"CHF",
"deleted":false,
"displayName":"Swiss Franc",
"repositoryId":"fr_CH",
"fractionalDigits":2,
"currencyCode":"CHF",
"numericCode":"756"
}
}
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|
|------------------|------------------|
|80005|The currency for the price list locale was not found.|
|80009|There was an error fetching the currency 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