Umbraco Commerce
CMSCloudHeartcoreDXP
13.latest (LTS)
13.latest (LTS)
  • Umbraco Commerce Documentation
  • Release Notes
    • v13.1.0-RC
  • Commerce Products
    • Commerce Packages
    • Commerce Payment Providers
    • Commerce Shipping Providers
  • Installation
    • Installing Umbraco Commerce
    • Licensing
  • Upgrading
    • Upgrading Umbraco Commerce
    • Version Specific Upgrade Notes
    • Migrate from Vendr to Umbraco Commerce
      • Migrate Umbraco Commerce Checkout
      • Migrate custom Payment Providers
  • Getting Started
    • Introduction
    • Umbraco Configuration
    • User Interface
  • How-To Guides
    • Overview
    • Configure SQLite support
    • Limit Order Line Quantity
    • Use an Alternative Database for Umbraco Commerce Tables
    • Add item to Cart
    • Update Cart
    • Delete item in Cart
    • Customizing Templates
  • Key Concepts
    • Get to know the main features
    • Base Currency
    • Bulk Actions
    • Calculators
    • Dependency Injection
    • Discount Rules / Rewards
    • Events
      • List of validation events
      • List of notification events
    • Fluent API
    • Order Calculation State
    • Payment Forms
    • Payment Providers
    • Pipelines
    • Price/Amount Adjustments
    • Price Freezing
    • Product Adapters
    • Product Bundles
    • Product Variants
      • Complex Variants
    • Properties
    • ReadOnly and Writable Entities
    • Search Specifications
    • Settings Objects
    • Shipping Package Factories
    • Shipping Providers
    • Shipping Range/Rate Providers
    • Tax Sources
    • UI Config Files
    • Umbraco Properties
    • Unit of Work
    • Umbraco Commerce Builder
    • Webhooks
  • Tutorials
    • Overview
  • Reference
    • Stores
    • Shipping
      • Fixed Rate Shipping
      • Dynamic Rate Shipping
      • Realtime Rate Shipping
    • Storefront API
      • Endpoints
        • Order
        • Checkout
        • Product
        • Customer
        • Store
        • Currency
        • Country
        • Payment method
        • Shipping method
        • Content
    • Go behind the scenes
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
Export as PDF
  1. Reference
  2. Storefront API
  3. Endpoints

Currency

PreviousStoreNextCountry

Last updated 1 year ago

Was this helpful?

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":" "}
expandstringOptional

Defines the properties that should be expanded in the response

Example: {"value":" "}
fieldsstringOptional

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 · uuidOptional

The ID of the current order associated with the current session

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

The ID or alias of the session default billing country

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

The ID or alias of the session default billing region

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

The ID or alias of the session default shipping country

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

The ID or alias of the session default shipping region

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

The ID or alias of the session default tax class

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

The ID or alias of the session currency

Example: {"value":"73a5a892-ceeb-4acd-ab08-d531d73f97e7"}
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_9418af18-1156-4505-9af6-96ff0f12b800
Responses
200
Success
application/json
404
Not Found
application/json
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",
    "culture": "text",
    "formatTemplate": "text",
    "allowedCountries": [
      {
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text"
        }
      }
    ]
  }
]

Gets a Currency by ID or Alias

get
Path parameters
idOrAliasstringRequired

The ID or the alias of the given resource

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

Defines the properties that should be expanded in the response

Example: {"value":" "}
fieldsstringOptional

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 · uuidOptional

The ID of the current order associated with the current session

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

The ID or alias of the session default billing country

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

The ID or alias of the session default billing region

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

The ID or alias of the session default shipping country

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

The ID or alias of the session default shipping region

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

The ID or alias of the session default tax class

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

The ID or alias of the session currency

Example: {"value":"fc0e3a30-5c0d-4bf8-8db9-0ca52d7f17bf"}
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_ec365a61-0ddf-4440-9d7f-35bb94ec7f37
Responses
200
Success
application/json
404
Not Found
application/json
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",
  "culture": "text",
  "formatTemplate": "text",
  "allowedCountries": [
    {
      "country": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text"
      }
    }
  ]
}
  • GETGets all the Currencies in a Store
  • GETGets a Currency by ID or Alias