listExchangeRates
get
/ccadmin/v1/exchangerates
List exchange rates. Get a list of exchange rates.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
The number of items to return.
-
offset(optional): integer
Index of the first element to return.
-
q(optional): string
A SCIM filter string for selecting a subset of all products. See [https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2)section 3.2.2.2 of the SCIM specification for details on the SCIM filter format. Examples: Get all products whose displayName contains shirt: q=displayName co "shirt" Get all products with an orderLimit between 5 and 10: q=orderLimit gt 5 and orderLimit lt 10 Text, date and time values appearing in SCIM filters should be quoted, with date and time values using ISO-8601 format. Numeric and boolean values should not be quoted. The following base product properties can be used in a q query: * avgCustRating * brand * childSKUs * description * displayName * id * largeImage * longDescription * notForIndividualSale * orderLimit * productImages * smallImage Additionally, custom product properties may also be used in a q query.
-
sort(optional): string
Sorting criteria.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listExchangeRates_response
Type:
Show Source
object
-
items(optional):
array items
List of exchange rate
-
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.
-
totalResults(optional):
integer
The total number of items.
Nested Schema : items
Type:
Show Source
object
-
exchangeRate(optional):
number
Multiplying factor to convert source currency value to target currency value
-
id(optional):
string
THe id of exchange rate.
-
sourceCurrency(optional):
string
The source currency code
-
targetCurrency(optional):
string
The target currency code
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)
{
"totalResults":2,
"offset":0,
"limit":5,
"sort":[
{
"property":"sourceCurrency",
"order":"asc"
}
],
"items":[
{
"targetCurrency":"POINTS",
"exchangeRate":"5",
"sourceCurrency":"USD",
"id":"10001"
},
{
"targetCurrency":"POINTS",
"exchangeRate":"7",
"sourceCurrency":"GBP",
"id":"10002"
}
]
}
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|
|------------------|------------------|
|180002|There was an error fetching the currency exchange rate 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