Catalog
Get Latest Catalog Sync Info
Latest-sync summary for an instance's catalog: the most recently updated catalog item plus total, mapped, and unmapped product counts. Useful before queuing a catalog refresh to decide whether a `since_latest` sync is sufficient.
Get Square Catalog Item
Get a single Square catalog item (product or variation), including its mapped SKU product and the raw Square catalog payload.
List Catalog Products
Return the paginated catalog for the buyer's account. Every item carries the buyer's resolved unit price, quantity-break ladder, order-value ladder prices and availability. Out-of-stock items remain listed (flagged), never hidden.
Get Catalog Product
Return full detail for a catalog product: images, description, specifications, quantity-break price table, availability with lead time, MOQ and case-pack hints, and — for matrix products — the purchasable variations each with their own price and availability. Returns 404 when the product is not resolvable in the active account's catalog. `back_in_stock_subscribed` (on the product and on each variation) is true when the authenticated buyer is waiting for a back-in-stock email for it; the portal shows 'You'll be notified' with a Stop action.
Get Catalog Filters
Return the brands, categories, and attributes available within the active account's catalog. Excluded brands/categories do not appear, so filter controls only ever offer values the buyer can actually see.
Get Catalog Facet Counts
Counts for building catalog filters, under the same filters as List Catalog Products. `total` is the number of products the filters return. `availability` counts products per availability value, `brands` and `categories` count products per brand / category id. Each facet is counted with every other filter applied but not its own, so the counts show what selecting that value would return (brands and categories stay multi-selectable).
Subscribe to Back-in-Stock Alert
Subscribe the authenticated buyer to a back-in-stock alert for an out-of-stock product. Idempotent — re-subscribing refreshes the pending alert. The buyer is emailed when the product's available-to-sell quantity next rises above zero. Returns 404 when the product is not resolvable in the active account's catalog.
Unsubscribe from Back-in-Stock Alert
Remove the authenticated buyer's back-in-stock alert for a product.