Currency

The Currency API endpoints allow fetching supported currencies from a store.

Gets all the Currencies in a Store

get

/umbraco/commerce/storefront/api/v1/currencies

Query parameters

filterstring

Filter the returned list of items

Example: {"value":" "}

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

Limit the properties returned in the response

Example: {"value":" "}

Header parameters

Api-Keystringrequired

API key specified through configuration to authorize access to the API.

Storestringrequired

The ID or the alias of the store

Example: {"value":"dbc1f7a2-6cb8-43c6-9489-30ba08d82c7f"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: e35b6b9d-dffe-4a41-a324-9d44b2e66b8d

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"837d138c-64af-4248-abc9-d93f747e3d94"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"14f54183-d1fe-482a-ae8c-90100bdc69a9"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"35c0687c-1754-4858-a1a2-26b684922a5b"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"df29f28f-708f-4704-a832-e17ec9f4015d"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"cad6bb8c-8829-4f92-8ce3-0e939f1043cf"}

Currencystring

The ID or alias of the session currency

Example: {"value":"73a5a892-ceeb-4acd-ab08-d531d73f97e7"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_9418af18-1156-4505-9af6-96ff0f12b800

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/currencies' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

404

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "culture": "text",
    "formatTemplate": "text",
    "allowedCountries": [
      {
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text"
        }
      }
    ]
  }
]

Success

Gets a Currency by ID or Alias

get

/umbraco/commerce/storefront/api/v1/currency/{idOrAlias}

Path parameters

idOrAliasstringrequired

The ID or the alias of the given resource

Example: {"value":"0cb10bb7-211f-498e-87fa-897caef86a48"}

Query parameters

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

Limit the properties returned in the response

Example: {"value":" "}

Header parameters

Api-Keystringrequired

API key specified through configuration to authorize access to the API.

Storestringrequired

The ID or the alias of the store

Example: {"value":"20b72b2c-3c21-4a30-b75a-3453556a5662"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: d98ede52-7168-4e57-bd70-6cc1c5c7d9e8

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"a54fe566-6ea2-459f-9b85-9a160210686a"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"3566f760-25d2-4231-bf91-7e8ac22a1f72"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"0e909dc8-a657-4b32-a9a1-47f8dde64e3f"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"4dbbfb54-3408-49ae-b0c7-39d1b48c6898"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"2fa21b66-1d08-463f-9cec-a47ad78efe9e"}

Currencystring

The ID or alias of the session currency

Example: {"value":"fc0e3a30-5c0d-4bf8-8db9-0ca52d7f17bf"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_ec365a61-0ddf-4440-9d7f-35bb94ec7f37

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/currency/{idOrAlias}' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "code": "text",
  "name": "text",
  "culture": "text",
  "formatTemplate": "text",
  "allowedCountries": [
    {
      "country": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text"
      }
    }
  ]
}

Success