List catalog products

A page of the products this buyer can see, with the buyer's prices (null when the store hides prices from signed-out visitors). Filter by search text, category (by name or handle), sort by featured, price or name, and page through with page and pageSize. On a store with delivery or pickup, pass the buyer's location (locationId, searchLocation or postalCode and country) so stock and lead times reflect it. Price sorting is refused (422) while prices are hidden.

Who may call it: Anyone on a public store (store.get answers access: "public"); on an invite or approval store a signed-in buyer (X-Storefront-Buyer), else 401 UNAUTHORIZED.

Body Params
string
length ≤ 200

Product name or SKU search.

string
length ≤ 500

Product category identifier.

enum
categoryValues
array of strings, unique
categoryValues
enum
integer
1 to 100000
integer
1 to 100
string
^[0-9a-fA-F-]{36}$
object | null
string
length ≤ 32
string
^[A-Z]{2}$
Headers
string
required
length between 1 and 253

The published storefront host the request serves (shop.example.com, lower case). It must belong to the tenant of the API key; 404 NOT_FOUND when no published storefront answers it, 403 FORBIDDEN when it belongs to another account.

string

The signed-in buyer's access token (accessToken from POST https://apis.kentro.live/auth/login/customer). Absent for a guest or an anonymous visitor.

string

The guest token session.guest answered, which identifies a guest cart and a guest checkout. Send it along with X-Storefront-Buyer at sign-in so the buyer can choose between the guest cart and the account cart.

string

The end buyer's IP address as your storefront server saw it. Used for per-visitor limits (search typeahead, sign-up); without it the limits apply to your server.

string

The store id (store.get answers id) your page was rendered for. When the host now resolves to another store the answer is 409 CONFLICT, so a stale page never acts on the wrong store.

string

The identity your page was rendered for: the buyer id, guest:<guestId> for a guest, or guest for an anonymous visitor. A mismatch with the tokens sent is 409 CONFLICT, so a stale page never acts for the wrong buyer.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json