Currency

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

Gets all the Currencies in a Store

get

Query parameters

LanguageIsoCodestringOptional

filterstringOptional

Filter the returned list of items

Example: {"value":" "}

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded 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":"80f81489-0a0e-4d51-b7ce-0a499f56eed2"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 82e86f75-9928-4395-b9f0-addadc385bf2

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"011be31f-063d-4d4d-97e2-d2ff5fb04fc5"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"e0a1625b-16ae-4084-8cbf-393ab0ade07c"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"9dc0c386-0f06-480e-aaa9-7d1d23ffb2fe"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"67f2bb55-c9af-4c27-a526-a9ad9070a875"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"cbcfe84c-780b-46c7-bbbd-f6a99e574d1f"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"84908219-7564-44b5-b055-ff0025176901"}

Accept-LanguagestringOptional

The ISO culture code of the current session culture

Example: en-US

Customer-ReferencestringOptional

The unique reference for the customer associated with the current session

Example: cust_2a7c0334-632d-4256-abbf-a83626f3ba48

Responses

200

application/json

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/currencies HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultCurrency": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]",
        "regions": "[Circular Reference]"
      },
      "defaultTaxClass": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "alias": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultTaxRate": 1,
        "defaultTaxCode": "text",
        "taxRate": 1,
        "taxCode": "text",
        "countryRegionTaxClasses": "[Circular Reference]"
      },
      "baseCurrency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "culture": "text",
        "symbol": "text",
        "decimalPlaces": 1,
        "decimalSeparator": "text",
        "groupSeparator": "text",
        "formatTemplate": "text",
        "allowedCountries": "[Circular Reference]"
      },
      "pricesIncludeTax": true
    },
    "culture": "text",
    "symbol": "text",
    "decimalPlaces": 1,
    "decimalSeparator": "text",
    "groupSeparator": "text",
    "formatTemplate": "text",
    "allowedCountries": [
      {
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text",
          "name": "text",
          "store": "[Circular Reference]",
          "defaultCurrency": "[Circular Reference]",
          "defaultPaymentMethod": "[Circular Reference]",
          "defaultShippingMethod": "[Circular Reference]",
          "regions": "[Circular Reference]"
        }
      }
    ]
  }
]

Gets a Currency by ID or Alias

get

Path parameters

idOrAliasone ofRequired

The ID or the alias of the given resource

Example: {"value":"71409002-2cb6-4910-9cf0-fa1a3534abb8"}

stringOptional

Query parameters

LanguageIsoCodestringOptional

fieldsstringOptional

Limit the properties returned in the response

Example: {"value":" "}

expandstringOptional

Defines the properties that should be expanded 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":"2cce5d4a-5393-4554-ac24-f11e2f764a3e"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 1cc7acdf-ba1a-4903-acc4-014796b0ddab

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"8ef9d1b6-2ab6-46fa-ab10-5f15373cafad"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"4271edf5-74c8-4092-bfe5-612b439a7029"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"7fc5d05b-1592-4fb3-8d26-adb14adae570"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"eca82ab7-2a2b-4d7a-a7f0-05ec3295dfc4"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"bbb8153e-b8f1-4b60-a5a1-90c16a9233d0"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"88269849-bec4-4c19-b3a0-68220fc756e5"}

Accept-LanguagestringOptional

The ISO culture code of the current session culture

Example: en-US

Customer-ReferencestringOptional

The unique reference for the customer associated with the current session

Example: cust_83c0d615-0884-48c6-b768-67888995fb9e

Responses

200

application/json

Responseone of

404

Not Found

get

GET /umbraco/commerce/storefront/api/v1/currency/{idOrAlias} HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "code": "text",
  "name": "text",
  "store": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "defaultCountry": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "defaultCurrency": "[Circular Reference]",
      "defaultPaymentMethod": "[Circular Reference]",
      "defaultShippingMethod": "[Circular Reference]",
      "regions": "[Circular Reference]"
    },
    "defaultTaxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "defaultTaxRate": 1,
      "defaultTaxCode": "text",
      "taxRate": 1,
      "taxCode": "text",
      "countryRegionTaxClasses": "[Circular Reference]"
    },
    "baseCurrency": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "culture": "text",
      "symbol": "text",
      "decimalPlaces": 1,
      "decimalSeparator": "text",
      "groupSeparator": "text",
      "formatTemplate": "text",
      "allowedCountries": "[Circular Reference]"
    },
    "pricesIncludeTax": true
  },
  "culture": "text",
  "symbol": "text",
  "decimalPlaces": 1,
  "decimalSeparator": "text",
  "groupSeparator": "text",
  "formatTemplate": "text",
  "allowedCountries": [
    {
      "country": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "defaultCurrency": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]",
        "regions": "[Circular Reference]"
      }
    }
  ]
}

PreviousStore NextCountry

Last updated 4 months ago

Was this helpful?