Get a single collection
Collections are used to organize and categorize products on your e-commerce platform (website and app), making it easier for shoppers to browse and find products. This endpoint gets category details such as basic info (ID, name, localized name, status, etc.), attributes details, categories included, categories excluded, associated child categories, and more.
Authorizations
S2S access token (JWT) from fabric Identity service (during Login)
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
Unique request ID
Path Parameters
System-generated 24-character collection ID
Query Parameters
Comma-separated locale codes of category. The service throws a 400 error if locale isn't supported. Standard locales can be found at https://www.rfc-editor.org/rfc/rfc5646. The recommended way to get the locale is by invoking multi-channel service
Response
Collection details
24-character system-generated collection ID
Non-localized collection name
Localized details
true: Collection name is translated into different languages or localized for different regions <br /> false: Collection name isn't localized Note: Refer to localizedProperties to get relevant details based on locale
true: Collection is root category.<br /> false: Collection isn't a root category.
true: Collection is active <br /> false: Collection is inactive
Collection attributes
List of categories included
List of categories excluded
Attribute filters applied to the category
Immediate children of the specified collection
Email of user who last updated the category
Time of last updated to category (UTC)
Time of category creation (UTC)
Was this page helpful?