Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listExchangeRates_response

Type: object

Show Source

• 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.

{
    "properties":{
        "total":{
            "description":"The total number of items.",
            "type":"integer"
        },
        "totalResults":{
            "description":"The total number of items.",
            "type":"integer"
        },
        "offset":{
            "description":"Index of the first element to return.",
            "type":"integer"
        },
        "limit":{
            "description":"The number of items to return.",
            "type":"integer"
        },
        "sort":{
            "description":"Sorting criteria.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The property the listing is sorted by.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Sort order: asc or desc.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"List of exchange rate",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "targetCurrency":{
                        "description":"The target currency code",
                        "type":"string"
                    },
                    "exchangeRate":{
                        "description":"Multiplying factor to convert source currency value to target currency value",
                        "type":"number"
                    },
                    "sourceCurrency":{
                        "description":"The source currency code",
                        "type":"string"
                    },
                    "id":{
                        "description":"THe id of exchange rate.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of exchange rate

Show Source

• Array of: object items

{
    "description":"List of exchange rate",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "targetCurrency":{
                "description":"The target currency code",
                "type":"string"
            },
            "exchangeRate":{
                "description":"Multiplying factor to convert source currency value to target currency value",
                "type":"number"
            },
            "sourceCurrency":{
                "description":"The source currency code",
                "type":"string"
            },
            "id":{
                "description":"THe id of exchange rate.",
                "type":"string"
            }
        }
    }
}

Nested Schema : sort

Type: array

Sorting criteria.

Show Source

• Array of: object items

{
    "description":"Sorting criteria.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The property the listing is sorted by.",
                "type":"string"
            },
            "order":{
                "description":"Sort order: asc or desc.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "targetCurrency":{
            "description":"The target currency code",
            "type":"string"
        },
        "exchangeRate":{
            "description":"Multiplying factor to convert source currency value to target currency value",
            "type":"number"
        },
        "sourceCurrency":{
            "description":"The source currency code",
            "type":"string"
        },
        "id":{
            "description":"THe id of exchange rate.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• order(optional): string
  Sort order: asc or desc.
• property(optional): string
  The property the listing is sorted by.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The property the listing is sorted by.",
            "type":"string"
        },
        "order":{
            "description":"Sort order: asc or desc.",
            "type":"string"
        }
    }
}

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.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top