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":"ba94d8dd-2bce-49ed-9417-cbf2781df175"}

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.

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: 8a35fbc5-1ab1-49cc-af1c-6c638e0ce8de

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"6ffe77e0-efd5-441a-9cad-dfc4f06a002b"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"3f613d08-0676-433a-838e-deaaa19ad6cc"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"777f5352-e709-4d8f-b1dd-6a934ed851fb"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"120a143d-c9f1-4fdc-b270-557e12a6ef88"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"97a1af8f-f460-4599-b3a0-1e389415e839"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"3daa83d3-a7b7-4999-9c6b-719f17e7c09c"}

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_8bb3d8b8-bf29-4a80-ac22-4ffb2159ab6e

Responses

200

OK

application/json

Responseone of

404

Not Found

get

/umbraco/commerce/storefront/api/v1/store/{idOrAlias}

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
}