Store

The Store API endpoints allow fetching supported store details.

Gets a Store by ID or Alias

get

Path parameters

idOrAliasone ofRequired

The ID or the alias of the given resource

Example: {"value":"479626da-5077-4af4-aca8-a6c41509de27"}

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.

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 1420ffe0-24a7-4340-842b-72612011be79

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"534539e0-be3d-4f29-a6ca-249078d57f8b"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"a20fae3a-8649-475e-a265-1b6c2625f54d"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"8f8c1ea6-0bec-45f4-83ce-1759060a7925"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"ae32d6fc-857c-47ec-a0ff-b1f2cc84bafd"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"ca46d002-6a37-47b0-9d62-53d544c3201b"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"0ad0ff55-3f81-4f09-9f78-3bf6b07da951"}

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_638e703a-29a4-40b2-bfda-e117eb7c8328

Responses

200

OK

application/json

Responseone of

404

Not Found

get

HTTPcURLJavaScriptPython

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",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": "[Circular Reference]",
      "defaultTaxClass": "[Circular Reference]",
      "baseCurrency": "[Circular Reference]",
      "pricesIncludeTax": true
    },
    "defaultCurrency": {
      "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]"
    },
    "defaultPaymentMethod": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "sku": "text",
      "taxClass": "[Circular Reference]",
      "paymentProviderAlias": "text",
      "imageUrl": "text"
    },
    "defaultShippingMethod": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "store": "[Circular Reference]",
      "sku": "text",
      "taxClass": "[Circular Reference]",
      "imageUrl": "text"
    },
    "regions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "store": "[Circular Reference]",
        "country": "[Circular Reference]",
        "defaultPaymentMethod": "[Circular Reference]",
        "defaultShippingMethod": "[Circular Reference]"
      }
    ]
  },
  "defaultTaxClass": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "alias": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": "[Circular Reference]",
      "defaultTaxClass": "[Circular Reference]",
      "baseCurrency": "[Circular Reference]",
      "pricesIncludeTax": true
    },
    "defaultTaxRate": 1,
    "defaultTaxCode": "text",
    "taxRate": 1,
    "taxCode": "text",
    "countryRegionTaxClasses": [
      {
        "store": "[Circular Reference]",
        "country": "[Circular Reference]",
        "region": "[Circular Reference]",
        "taxRate": 1,
        "taxCode": "text"
      }
    ]
  },
  "baseCurrency": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text",
      "name": "text",
      "defaultCountry": "[Circular Reference]",
      "defaultTaxClass": "[Circular Reference]",
      "baseCurrency": "[Circular Reference]",
      "pricesIncludeTax": true
    },
    "culture": "text",
    "symbol": "text",
    "decimalPlaces": 1,
    "decimalSeparator": "text",
    "groupSeparator": "text",
    "formatTemplate": "text",
    "allowedCountries": [
      {
        "country": "[Circular Reference]"
      }
    ]
  },
  "pricesIncludeTax": true
}