Currency

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

Gets all the Currencies in a Store

get

Query parameters

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":"f04853f8-49ad-4938-806a-196614ea2104"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 6f1b61c5-7953-4d34-8f94-a6f7d886a6f5

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"a068c065-f262-4222-8ff5-a8c339b0d46b"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"3d090e57-6ed2-4c9d-9e37-50ba479e81fc"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"c6945052-4b36-49fa-8595-02663af129b9"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"7b3f72a6-2f77-4037-a305-ee85d559b314"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"ff3dfe56-50ac-4e85-842e-d7012894fa91"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"9284a2fa-e1d1-46a5-8c24-7221d34e0f1e"}

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_039ab087-b115-40fc-a92e-db3f38973fdf

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":"b731317d-121a-40bb-9739-776f2f187b7b"}

stringOptional

Query parameters

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":"41d12836-2567-4112-98bb-0488cea26648"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 170c673b-ba60-4308-98d5-ae47549d0e84

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"bed3d62f-689b-4791-b8fd-2564f3cd405e"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"fee2e447-035d-41fb-8807-a1d79681dd69"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"21995dc0-8784-44bc-b760-1f7d1c830ed2"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"10fbc3f9-56a0-4787-af2b-a3b0bf0d0612"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"84dd054c-1cf5-47a9-95b1-2bf16911eab4"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"ee9577ef-41f2-415e-bb88-e783d76992a6"}

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_047f3860-c22a-4f7c-8cca-2eb3f81183db

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 3 months ago

Was this helpful?