Store

The Store API endpoints allow fetching supported store details.

Gets a Store by ID or Alias

get

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

Path parameters

idOrAliasstringrequired

The ID or the alias of the given resource

Example: {"value":"805e2989-7e91-4649-bbf1-35374f65ac28"}

Query parameters

expandstring

Defines the properties that should be expanded in the response

Example: {"value":" "}

fieldsstring

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

The ID of the current order associated with the current session

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

Billing-Countrystring

The ID or alias of the session default billing country

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

Billing-Regionstring

The ID or alias of the session default billing region

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

Shipping-Countrystring

The ID or alias of the session default shipping country

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

Shipping-Regionstring

The ID or alias of the session default shipping region

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

Tax-Classstring

The ID or alias of the session default tax class

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

Currencystring

The ID or alias of the session currency

Example: {"value":"ccadbfd4-0f08-418c-8a7f-02dbd736135f"}

Accept-Languagestring

The ISO culture code of the current session culture

Example: en-US

Customer-Referencestring

The unique reference for the customer associated with the current session

Example: cust_95e41d45-068b-47bd-9d13-5a75de4a757e

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/store/{idOrAlias}' \
  --header 'Api-Key: text'

200

404

200

{
  "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
}

Success