Magento2

Get currency information for the store

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://magento2.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Magento2 MCP server": {
    "url": "https://magento2.doc.winkelstraat.nl/mcp"
  }
}
Close
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

      The list of exchange rate information for the store.

      Hide exchange_rates attributes Show exchange_rates attributes object

      Exchange Rate interface.

      • 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

    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

      The list of exchange rate information for the store.

      Hide exchange_rates attributes Show exchange_rates attributes object

      Exchange Rate interface.

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

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

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

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

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

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • 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 (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <base-currency-code>string</base-currency-code>
  <base-currency-symbol>string</base-currency-symbol>
  <default-display-currency-code>string</default-display-currency-code>
  <default-display-currency-symbol>string</default-display-currency-symbol>
  <available-currency-codes type="array">
    <available-currency-code>string</available-currency-code>
  </available-currency-codes>
  <exchange-rates type="array">
    <exchange-rate>
      <currency-to>string</currency-to>
      <rate type="float">42.0</rate>
      <extension-attributes>
      </extension-attributes>
    </exchange-rate>
  </exchange-rates>
  <extension-attributes>
  </extension-attributes>
</root>
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"
}
Response examples (default) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>