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

Query parameters

LanguageIsoCodestringOptional

productReferencestringOptional

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

Example: {"value":"659ef62c-6ffd-487b-84b3-6db832a034fc"}

CalculateAdjustedPricesbooleanOptional

AdjustedPriceCalculationQuantitynumber · doubleOptional

AdjustedPriceCalculationDiscountCodesstring[]Optional

AdjustedPriceCalculationPriceCacheDurationinteger · int32Optional

AdjustedPriceCalculationTempOrderCacheDurationinteger · int32Optional

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.

StorestringRequired

The ID or the alias of the store

Example: {"value":"908fa2e7-f60a-4f44-93ce-1f2796c71e45"}

Current-OrderstringOptional

The ID of the current order associated with the current session

Example: ed180e11-9c0b-463c-adf4-4b5e730cc01e

Billing-CountrystringOptional

The ID or alias of the session default billing country

Example: {"value":"c4357de8-6b38-405e-8c5a-26e48e1262fe"}

Billing-RegionstringOptional

The ID or alias of the session default billing region

Example: {"value":"0b2c20d9-f319-4927-99fb-5f8a7a556125"}

Shipping-CountrystringOptional

The ID or alias of the session default shipping country

Example: {"value":"93c342e4-a030-480d-8ab5-4ee6a1e20358"}

Shipping-RegionstringOptional

The ID or alias of the session default shipping region

Example: {"value":"5c327ebb-050d-4b57-8ed8-cef69ce13ea4"}

Tax-ClassstringOptional

The ID or alias of the session default tax class

Example: {"value":"3e4056a0-a294-4270-abda-e3cef81d848e"}

CurrencystringOptional

The ID or alias of the session currency

Example: {"value":"66dfc510-eaf6-4bb3-a54c-6b52dbcec549"}

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_dfcc32ca-d8f1-483f-899e-e4a058c3cde3

Responses

200

OK

application/json

400

Bad Request

get

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

HTTPcURLJavaScriptPython

GET /umbraco/commerce/storefront/api/v1/products HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*

[
  {
    "productReference": "text",
    "sku": "text",
    "name": "text",
    "productVariantReference": "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"
      }
    },
    "priceWithAdjustments": {
      "unitPrice": {
        "currency": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text"
        },
        "withoutTax": 1,
        "tax": 1,
        "withTax": 1,
        "formatted": {
          "withoutTax": "text",
          "tax": "text",
          "withTax": "text"
        }
      },
      "quantity": 1,
      "adjustedUnitPrice": {
        "adjustments": [
          {
            "name": "text",
            "type": "text",
            "price": {
              "currency": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "code": "text"
              },
              "withoutTax": 1,
              "tax": 1,
              "withTax": 1,
              "formatted": {
                "withoutTax": "text",
                "tax": "text",
                "withTax": "text"
              }
            },
            "originalPrice": {
              "currency": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "code": "text"
              },
              "withoutTax": 1,
              "tax": 1,
              "withTax": 1,
              "formatted": {
                "withoutTax": "text",
                "tax": "text",
                "withTax": "text"
              }
            },
            "metaData": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ],
        "withoutAdjustments": {
          "currency": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text"
          },
          "withoutTax": 1,
          "tax": 1,
          "withTax": 1,
          "formatted": {
            "withoutTax": "text",
            "tax": "text",
            "withTax": "text"
          }
        },
        "adjustment": {
          "currency": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text"
          },
          "withoutTax": 1,
          "tax": 1,
          "withTax": 1,
          "formatted": {
            "withoutTax": "text",
            "tax": "text",
            "withTax": "text"
          }
        },
        "value": {
          "currency": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text"
          },
          "withoutTax": 1,
          "tax": 1,
          "withTax": 1,
          "formatted": {
            "withoutTax": "text",
            "tax": "text",
            "withTax": "text"
          }
        }
      },
      "adjustedLineTotalPrice": {
        "adjustments": [
          {
            "name": "text",
            "type": "text",
            "price": {
              "currency": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "code": "text"
              },
              "withoutTax": 1,
              "tax": 1,
              "withTax": 1,
              "formatted": {
                "withoutTax": "text",
                "tax": "text",
                "withTax": "text"
              }
            },
            "originalPrice": {
              "currency": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "code": "text"
              },
              "withoutTax": 1,
              "tax": 1,
              "withTax": 1,
              "formatted": {
                "withoutTax": "text",
                "tax": "text",
                "withTax": "text"
              }
            },
            "metaData": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ],
        "withoutAdjustments": {
          "currency": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text"
          },
          "withoutTax": 1,
          "tax": 1,
          "withTax": 1,
          "formatted": {
            "withoutTax": "text",
            "tax": "text",
            "withTax": "text"
          }
        },
        "adjustment": {
          "currency": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text"
          },
          "withoutTax": 1,
          "tax": 1,
          "withTax": 1,
          "formatted": {
            "withoutTax": "text",
            "tax": "text",
            "withTax": "text"
          }
        },
        "value": {
          "currency": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text"
          },
          "withoutTax": 1,
          "tax": 1,
          "withTax": 1,
          "formatted": {
            "withoutTax": "text",
            "tax": "text",
            "withTax": "text"
          }
        }
      },
      "effectiveUnitPrice": {
        "currency": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text"
        },
        "withoutTax": 1,
        "tax": 1,
        "withTax": 1,
        "formatted": {
          "withoutTax": "text",
          "tax": "text",
          "withTax": "text"
        }
      },
      "totalDiscountPerUnit": {
        "currency": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "text"
        },
        "withoutTax": 1,
        "tax": 1,
        "withTax": 1,
        "formatted": {
          "withoutTax": "text",
          "tax": "text",
          "withTax": "text"
        }
      },
      "totalDiscountPercentage": 1,
      "discountCodes": [
        {
          "discount": "[Circular Reference]",
          "code": "text",
          "isFulfilled": true
        }
      ],
      "discounts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "alias": "text"
        }
      ]
    },
    "stock": 1,
    "attributes": [
      {
        "name": {
          "alias": "text",
          "name": "text"
        },
        "value": {
          "alias": "text",
          "name": "text"
        }
      }
    ],
    "taxClass": {
      "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"
        }
      ]
    },
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "isGiftCard": true
  }
]