Get Currency Exchange Rate

Retrieves a single exchange rate for a specified currency code and target currency code.

GET /commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}

Error

A valid request URL is required to generate request examples

200

{
  "rate": 123,
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "fromCurrencyCode": "<string>",
  "multiplier": 123,
  "referenceData": "<string>",
  "toCurrencyCode": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

currencyCode · string · required

Currency code

toCurrencyCode · string · required

Target currency code

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

The exchange rate between two currencies

rate · number<double> · required

The exchange rate

auditInfo · object

Show child attributes

fromCurrencyCode · string | null

The source currency code

multiplier · number<double> | null

An additional multiplier to use in calculations

referenceData · string | null

Reference data for miscellaneous metadata from updates

toCurrencyCode · string | null

The target currency code