Find categories
Finds categories, by keywords, category identifiers, type, or status.
Note:
1) Categories and children categories must already exist in the system.
2) When query parameters are omitted, this endpoint returns a paginated response with all the categories. Using size
and page
, you can narrow down the search results.
3) GET /v1/category (Store admin context) or Algolia search (Shopper context) is strongly recommended over this endpoint.
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.
Query Parameters
Keywords to search for categories. The response is paginated. Using query parameters page
and size
, you can narrow down the search results.
A 24-characters system-generated category IDs. If ids
and nodeIds
are omitted, this endpoint returns a paginated response. Using query parameters page
and size
, you can narrow down the search results.
Numeric category IDs. If ids
and nodeIds
are omitted, this endpoint returns a paginated response. Using query parameters page
and size
, you can narrow down the search results.
Category type. <br /> Note: If omitted, you will get a paginated response with ALL
categories. Using query parameters page
and size
, you can narrow down the search results.
PRIMARY
, ALTERNATE
, ALL
Category status. If omitted, you will get a paginated response of categories in ACTIVE
status. Using the query parameters page
and size
, you can narrow down the search results. <br /> Note: When type
is Primary, status
must be Active. Inactive status is not applicable for Primary category.
ACTIVE
, INACTIVE
, ALL
Page number to be retrieved. <br /> Note: <br /> 1) Applicable only in a paginated response. <br /> 2) Always paired with size
<br /> 3) No default value set. Unless a value is specified, endpoint returns an error.
Number of records per page <br /> Note: <br /> 1) Always paired with page
. <br /> 2) Applicable only in a paginated response. <br /> 3) No default value set. Unless a value is specified, endpoint returns an error.
Was this page helpful?