Products Guide
Search the catalog, and look up product details and available add-ons by SKU and delivery address
The Products API allows you to search the product catalog and retrieve product information including pricing and available add-ons, tailored to a specific delivery address. This is useful for building product search and detail pages, previewing add-on options, or validating product availability before creating an offer.
Benefits
- Search: Find products by free-text term, supplier, category, and physical dimensions
- Discovery: Look up any product by SKU and see its current availability and pricing
- Add-Ons: Retrieve grouped add-on products and included parts available for a given address
- Address-Aware: Results reflect availability and pricing based on the customer’s delivery location
Core Concepts
Product
A product identified by SKU with a title and price
Add-On
A named collection of related add-on products (e.g., Install, Disconnect)
Add-On Product
An individual add-on item with its own SKU, category, and price
Recommended Part
A related product which may not be included in an add-on group (e.g. Laundry Storage Pedestal)
Authentication
GET /products (search) requires a Public REST API token that carries the read:products scope. Create
the token in the developer dashboard and grant it that scope, then send it
as Authorization: Bearer <token>. A request with a token that lacks the scope receives a 403 with code
INSUFFICIENT_SCOPE; a token issued for the GraphQL API receives a 403 with code REST_TOKEN_REQUIRED.
GET /products/{sku} accepts the same Public REST API token, applies the same read:products scope
check, and refuses a GraphQL token with the same 403 REST_TOKEN_REQUIRED.
Next Steps
Review Documentation
Development
Production
Endpoints
Products endpoints
Every endpoint with parameters, response schemas, and code samples.