Product

The Product API endpoints allow fetching essential product related data such as pricing and stock levels.

Gets one or more Products by product reference

get

/umbraco/commerce/storefront/api/v1/products

Query parameters

productReferencestring

One or more product references of products / product variants to retrieve.

Example: {"value":"27ee0e97-9dc5-4d47-9a8d-356923ce194c"}

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.

Storestringrequired

The ID or the alias of the store

Example: {"value":"ab5c64bf-8a31-468c-baba-ae8d61e73547"}

Current-Orderstring · uuid

The ID of the current order associated with the current session

Example: bb750847-8a8c-419c-bb9a-163f96d89d7f

Billing-Countrystring

The ID or alias of the session default billing country

Example: {"value":"52fbd0e4-e65f-4928-ac1e-e4c8e5250d8a"}

Billing-Regionstring

The ID or alias of the session default billing region

Example: {"value":"a762c4fc-2601-4331-ab6f-485ce36718c9"}

Shipping-Countrystring

The ID or alias of the session default shipping country

Example: {"value":"33e7cd54-cbc6-4d1e-a326-967f01d2a3aa"}

Shipping-Regionstring

The ID or alias of the session default shipping region

Example: {"value":"863e6466-21aa-410a-bf86-1861825690a1"}

Tax-Classstring

The ID or alias of the session default tax class

Example: {"value":"5517a711-4742-42a7-a733-c315355cff1f"}

Currencystring

The ID or alias of the session currency

Example: {"value":"57b6cae2-69ad-40ef-ad6f-beb164bc4aff"}

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_de245ace-3fb2-4dbd-8cff-f09f67b7f5e7

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/umbraco/commerce/storefront/api/v1/products' \
  --header 'Api-Key: text' \
  --header 'Store: text'

200

400

200

[
  {
    "productReference": "text",
    "productVariantReference": "text",
    "sku": "text",
    "name": "text",
    "imageUrl": "text",
    "price": {
      "currency": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text"
      },
      "withoutTax": 1,
      "tax": 1,
      "withTax": 1,
      "formatted": {
        "withoutTax": "text",
        "tax": "text",
        "withTax": "text"
      }
    },
    "stock": 1,
    "attributes": [
      {
        "name": {
          "alias": "text",
          "name": "text"
        },
        "value": {
          "alias": "text",
          "name": "text"
        }
      }
    ],
    "taxClass": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "alias": "text"
    },
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "isGiftCard": true
  }
]

Success