Magento2

Get currency information for the store

GET /V1/directory/currency

Get currency information for the store.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • base_currency_code string Required

      The base currency code for the store.

    • base_currency_symbol string Required

      The currency symbol of the base currency for the store.

    • default_display_currency_code string Required

      The default display currency code for the store.

    • default_display_currency_symbol string Required

      The currency symbol of the default display currency for the store.

    • available_currency_codes array[string] Required

      The list of allowed currency codes for the store.

    • exchange_rates array[object] Required

      Exchange Rate interface.

      Exchange Rate interface.

      Hide exchange_rates attributes Show exchange_rates attributes object
      • currency_to string Required

        The currency code associated with the exchange rate.

      • rate number Required

        The exchange rate for the associated currency and the store's base currency.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface
  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
GET /V1/directory/currency 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/directory/currency'
Response examples (200) 
{
  "base_currency_code": "string",
  "base_currency_symbol": "string",
  "default_display_currency_code": "string",
  "default_display_currency_symbol": "string",
  "available_currency_codes": [
    "string"
  ],
  "exchange_rates": [
    {
      "currency_to": "string",
      "rate": 42.0,
      "extension_attributes": {}
    }
  ],
  "extension_attributes": {}
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}