Umbraco Commerce
CMSCloudHeartcoreDXP
14.latest
14.latest
  • Umbraco Commerce Documentation
  • Release Notes
    • v14.0.0
    • v14.0.0-Alpha
  • Commerce Products
    • Commerce Packages
    • Commerce Payment Providers
    • Commerce Shipping Providers
  • Getting Started
    • Requirements
    • Installation
    • Licensing
    • Configuration
    • User Interface
  • Upgrading
    • Upgrading Umbraco Commerce
    • Version Specific Upgrade Notes
    • Migrate from Vendr to Umbraco Commerce
      • Migrate Umbraco Commerce Checkout
      • Migrate custom Payment Providers
  • How-To Guides
    • Overview
    • Configure SQLite support
    • Limit Order Line Quantity
    • Use an Alternative Database for Umbraco Commerce Tables
    • Add item to Cart
    • Update Cart
    • Delete item from Cart
  • Key Concepts
    • Get to know the main features
    • Base Currency
    • Calculators
    • Currency Exchange Rate Service Provider
    • Dependency Injection
    • Discount Rules / Rewards
    • Events
      • List of validation events
      • List of notification events
    • Fluent API
    • Order Calculation State
    • Payment Forms
    • Payment Providers
    • Pipelines
    • Price/Amount Adjustments
    • Price Freezing
    • Product Adapters
    • Product Bundles
    • Product Variants
      • Complex Variants
    • Properties
    • ReadOnly and Writable Entities
    • Sales Tax Providers
    • Search Specifications
    • Settings Objects
    • Shipping Package Factories
    • Shipping Providers
    • Shipping Range/Rate Providers
    • Tax Sources
    • UI Extensions
      • Analytics Widgets
      • Entity Quick Actions
      • Order Properties
      • Order Collection Properties
      • Order Line Properties
      • Store Menu Items
    • Umbraco Properties
    • Unit of Work
    • Umbraco Commerce Builder
    • Webhooks
  • Reference
    • Stores
    • Shipping
      • Fixed Rate Shipping
      • Dynamic Rate Shipping
      • Realtime Rate Shipping
    • Taxes
      • Fixed Tax Rates
      • Calculated Tax Rates
    • Storefront API
      • Endpoints
        • Order
        • Checkout
        • Product
        • Customer
        • Store
        • Currency
        • Country
        • Payment method
        • Shipping method
        • Content
    • Management API
    • Go behind the scenes
    • Telemetry
  • Tutorials
    • Overview
    • Getting started with Umbraco Commerce: The Backoffice
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
Export as PDF
  1. Reference
  2. Storefront API
  3. Endpoints

Product

PreviousCheckoutNextCustomer

Last updated 1 year ago

Was this helpful?

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
productReferencestringOptional

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

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

Defines the properties that should be expanded in the response

Example: {"value":" "}
fieldsstringOptional

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 ยท uuidOptional

The ID of the current order associated with the current session

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

The ID or alias of the session default billing country

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

The ID or alias of the session default billing region

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

The ID or alias of the session default shipping country

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

The ID or alias of the session default shipping region

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

The ID or alias of the session default tax class

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

The ID or alias of the session currency

Example: {"value":"57b6cae2-69ad-40ef-ad6f-beb164bc4aff"}
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_de245ace-3fb2-4dbd-8cff-f09f67b7f5e7
Responses
200
Success
application/json
400
Bad Request
application/json
get
GET /umbraco/commerce/storefront/api/v1/products HTTP/1.1
Host: 
Api-Key: text
Store: text
Accept: */*
[
  {
    "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
  }
]