Products
Each product in your catalog is identified by aProductId and a Sku. The table below covers the key fields returned on product responses.
Example: product response
Price tiers
Nymble Commerce’s pricing system is tier-based and token-driven. Each product carries aPrices array — a list of ProductPrice objects, one per tier defined in your organization.
Each ProductPrice has:
How tier resolution works: when an authenticated customer calls any catalog endpoint, Nymble Commerce reads the
PriceTier claim from their JWT and returns the matching price in the top-level Price and PriceFormatted fields. The full Prices array is also included in the response so your storefront can display tiered or volume pricing tables.
Categories
Products are organized into a hierarchy of categories and subcategories. Use the categories API to build navigation menus, filter panels, and breadcrumb trails in your storefront. Each category has:
Root categories have no parent. Subcategories are nested within their parent’s
SubCategories array. A single API call to GET /api/categories returns the full tree.
Images
Products support multiple images, served through Cloudflare’s CDN for fast, globally-distributed delivery. Image URLs are included in theImages array on product responses.
Each image object contains a URL and metadata. Images are managed via the Cloudflare Images integration configured at the organization level — you upload once and Nymble Commerce handles resizing and CDN distribution automatically.
Category images follow the same CDN pattern, with the URL constructed from your OrganizationId and the category’s Breadcrumb.
Product states
Use inactive state for seasonal items, discontinued products, or anything you want to retain in the system without surfacing to customers.
Searching and filtering
The product search endpoint supports:- Full-text search across
NameandDescription. - Category filter — return products belonging to a specific category.
- Price range filter — filter by minimum and/or maximum price (resolved to the authenticated user’s tier).
- Active status filter — include or exclude inactive products (admin only).
PageNumber and PageSize query parameters to navigate pages.