Get categories
Gets categories and their details including attributes, breadcrumbs, and details of children categories.
Note:
1) Specify either ids
or nodeIds
to get specific categories.
2) Use type
to get a specific category type.
3) When query parameters are omitted, this endpoint returns a paginated response listing all Alternate categories in Active status. Using the query parameters size
and page
, you can narrow down the search 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.
Query Parameters
A 24-character system-generated category IDs. If ids
and nodeIds
are omitted, this endpoint returns all Alternate categories in Active status. Using size
and page
, you can narrow down the search results.
Numeric category IDs. When ids
and nodeIds
are omitted, specify size
and page
to narrow down the search results.
Keywords to search for categories. You will get a pagination response. Using size
and page
, you can narrow down the search results.
Category type. <br /> Note: When omitted, you will get ALTERNATE
categories by default.
PRIMARY
, ALTERNATE
, ALL
Category status. <br /> Note: If omitted, you will get Alternate categories in Active status by default. <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?