1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Currency Exchange Rate

listExchangeRates

get

/ccadmin/v1/exchangerates

List exchange rates. Get a list of exchange rates.

Request

Supported Media Types
  • application/json
Query Parameters
limit
Type: integer
The number of items to return.
offset
Type: integer
Index of the first element to return.
q
Type: 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
Type: string
Sorting criteria.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listExchangeRates_response
Nested Schema : items
Type: array
List of exchange rate
Nested Schema : sort
Type: array
Sorting criteria.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example 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.|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "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"
    }
  ]
}