List Catalog Products
GET/api/portal/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.
Called by a B2B portal buyer with the bearer token POST /api/portal/auth/login returns (or the buyer's feed key) — not with a staff Personal Access Token.
Filters combine with AND; brand_ids, category_ids and availability are each multi-select (any of). Sort by name, sku or brand with direction asc/desc.
Each item's back_in_stock_subscribed is true when the authenticated buyer has asked to be emailed when that product is back in stock and has not been emailed yet.
An unknown availability value returns 422.
Product lifecycle: each product carries lifecycle_badge — Last units while a product that is being sold through (Discontinued, or a custom state that stops replenishment) still has stock, Ending soon while it is Phasing out, otherwise null — and successor (id, sku, name of the product that replaces it, or null). successor is only set when the replacement is itself visible to this buyer; for a variation, id is its parent product page. Products whose lifecycle state hides them from the portal are not listed.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.