Find categories
Using this endpoint, you can search for categories and collections based on status, type, or category attributes. You will get a paginated response, which you can fine tune by specifying the query parameters page
and size
.
Data is retrieved from the database, ensuring latest results.
Authorizations
S2S access token (JWT) from fabric Identity service (during Login)
Headers
The x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
Body
Inclusion criteria
Number of pages in the response.
Number of categories per page.
Category status. Only ALTERNATE Hierarchies can be filtered using this paramater. If omitted ACTIVE
status is considered by default.
ACTIVE
, INACTIVE
, ALL
Category type. The primary hierarchy contains all branches, whereas alternate hierarchies exist to export alternate organizations of the primary hierarchy. If omitted ALTERNATE
is considered by default.
PRIMARY
, ALTERNATE