POST
/
browse
/
{collectionHandle}

Authorization

X-Storefront-Access-Token
string
required

Token-based authentication header in the form of <YOUR_LAYERS_TOKEN>.

Headers

Content-Type
string
default: "application/json"required
Accept
string
default: "application/json"required

Path Parameters

collectionHandle
string
required

The handle of the collection you wish to browse.

Body

sort_order_code
string
required

Code of the sort order.

filter_group
object

Refer to our dedicated Filter Expressions guide to learn more about filter expressions.

pagination
Pagination Object
facets
string[]

Facets to be included.

retrieveFacetCount
boolean

If the count of each facet value should be calculated

userToken
string
deprecated

User’s unique token (optional).

identity
object

Information used to current identify the customer/session.

context
object

Anonymous contextual information of the session/customer.

attributes
string[]

Product attributes to include in the Response. By default all attributes are included in the response.

Response

results
Array of Objects
totalResults
number

The total number of results.

page
number

The current page number.

totalPages
number

The total number of pages.

facets
object

If retrieveFacetCount is true then an object with keys and values of the specified attributes.

attributionToken
string

The attribution token.

_meta
object