Umbraco Commerce
CMSCloudHeartcoreDXP
14.latest
14.latest
  • Umbraco Commerce Documentation
  • Release Notes
    • v14.0.0
    • v14.0.0-Alpha
  • Commerce Products
    • Commerce Packages
    • Commerce Payment Providers
    • Commerce Shipping Providers
  • Getting Started
    • Requirements
    • Installation
    • Licensing
    • Configuration
    • User Interface
  • Upgrading
    • Upgrading Umbraco Commerce
    • Version Specific Upgrade Notes
    • Migrate from Vendr to Umbraco Commerce
      • Migrate Umbraco Commerce Checkout
      • Migrate custom Payment Providers
  • 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 from Cart
  • Key Concepts
    • Get to know the main features
    • Base Currency
    • Calculators
    • Currency Exchange Rate Service Provider
    • 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
    • Sales Tax Providers
    • Search Specifications
    • Settings Objects
    • Shipping Package Factories
    • Shipping Providers
    • Shipping Range/Rate Providers
    • Tax Sources
    • UI Extensions
      • Analytics Widgets
      • Entity Quick Actions
      • Order Properties
      • Order Collection Properties
      • Order Line Properties
      • Store Menu Items
    • Umbraco Properties
    • Unit of Work
    • Umbraco Commerce Builder
    • Webhooks
  • Reference
    • Stores
    • Shipping
      • Fixed Rate Shipping
      • Dynamic Rate Shipping
      • Realtime Rate Shipping
    • Taxes
      • Fixed Tax Rates
      • Calculated Tax Rates
    • Storefront API
      • Endpoints
        • Order
        • Checkout
        • Product
        • Customer
        • Store
        • Currency
        • Country
        • Payment method
        • Shipping method
        • Content
    • Management API
    • Go behind the scenes
    • Telemetry
  • Tutorials
    • Overview
    • Getting started with Umbraco Commerce: The Backoffice
Powered by GitBook
On this page

Was this helpful?

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

Store

PreviousCustomerNextCurrency

Last updated 1 year ago

Was this helpful?

The Store API endpoints allow fetching supported store details.

Gets a Store by ID or Alias

get
Path parameters
idOrAliasstringRequired

The ID or the alias of the given resource

Example: {"value":"805e2989-7e91-4649-bbf1-35374f65ac28"}
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.

Current-Orderstring ยท uuidOptional

The ID of the current order associated with the current session

Example: 1092cdf5-dda3-4ae4-a07a-81e3a9fd8bfe
Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"6f34bfec-acd7-46c7-b472-499528af25f4"}
Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"5cbe3147-a891-4fa7-bd52-d55116d84fca"}
Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"e4567d73-227b-4817-9b07-95a79f7a9682"}
Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"a5a48afe-1b7d-4540-9a53-f0792c79d6f4"}
Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"a5cc0430-e423-47fe-8ab8-85e2e3b017a4"}
CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"ccadbfd4-0f08-418c-8a7f-02dbd736135f"}
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_95e41d45-068b-47bd-9d13-5a75de4a757e
Responses
200
Success
application/json
404
Not Found
application/json
get
GET /umbraco/commerce/storefront/api/v1/store/{idOrAlias} HTTP/1.1
Host: 
Api-Key: text
Accept: */*
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "alias": "text",
  "name": "text",
  "defaultCountry": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text"
  },
  "defaultTaxClass": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text"
  },
  "baseCurrency": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text"
  },
  "pricesIncludeTax": true
}