Storefront API
The Storefront API is a read-only API that serves indexed product data to your headless commerce frontend. It is the primary interface between Avvyr and your online store.
Overview
The Storefront API provides:
- Product search with full-text search, faceted filtering, and sorting.
- Category browsing with products resolved per category.
- Product detail lookups by SKU or product ID.
- Variant group resolution for grouped product displays.
- Search suggestions for autocomplete functionality.
- Shipping options for storefront checkout flows.
Authentication
All Storefront API requests require a storefront token passed as an API key. See Storefront Tokens for how to generate and manage tokens.
Per-market endpoints
The Storefront API is market-scoped. Each request targets a specific market, which determines:
- The currency and language of returned data.
- The pricing applied to products.
- The visibility rules that filter which products are returned.
- The stock levels based on configured warehouses.
Key capabilities
Product search
Search products with:
- Full-text queries across product names and attributes.
- Faceted filters (categories, brands, attributes, price ranges).
- In-stock filtering with warehouse-level granularity.
- Sorting by relevance, price, name, or other fields.
Category products
Retrieve products belonging to a specific category, including products matched by automatic category rules.
Product by SKU
Fetch a single product by its SKU for product detail pages.
Variant groups
Retrieve all products in a variant group by the group ID. This powers "select your size/color" displays on product pages.
Search suggestions
Get typeahead suggestions for search inputs.
Shipping options
Resolve available shipping methods and costs for a specific market during checkout.
API documentation
For full endpoint documentation, request/response schemas, and code examples, visit the Avvyr Developer Documentation.