Product Catalog User Guides
- Overview
- Data Ingestion Best Practices
- List
- Attributes
- Categories
- Collections
- Background Jobs
- Settings
Catalog Connector User Guides
- Overview
- Items
- Bundles
Product Catalog API
- Product Catalog API - Overview
- Developer Guide
- Data Ingestion Best Practices
- Attributes & Attribute Mapping
- Categories
- Products
- Collections
- Background Jobs
- Bulk Import & Export
- Published Products
Catalog Connector API
- Overview
- Files
- Jobs
- Operations
Find collections
This endpoint enables you to find collections by the search criteria you specify in the request body. You can also sort
the results.
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
Body
Specification for matching attributes
Searches for attributes that matches the query. Append locale and name with a #
as a value
Operations that can be performed on a string
type
IN
If isLocalizable
is true, searches for the requested name in the list of locales provided here. If isLocalizable
is false, searches for the non-localized names.
24-character system-generated attribute ID
Attribute value
Operations that can be performed on a string
type
IN
, NOT_IN
If isLocalizable
is true, searches for the requested name in the list of locales provided here. If isLocalizable
is false, searches for the non-localized names.
Sorting criteria. Sorting is supported only on createdAt, updatedAt. -
refers to descending while +
refers to ascending order
Number of records to skip before returning records. For example, offset=20, limit=10
returns records 21-30.
Maximum number of records per page
Response
Search response
Number of records to skip before returning records. For example, offset=20, limit=10
returns records 21-30.
Maximum number of records per page
Total number of records in the response
24-character system-generated collection ID
Non-localized collection name
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
24-character system-generated attribute ID
Non-localized attribute name
true: Attribute name can be translated into different languages or localized for different regions. <br /> false: Attribute name can't be localized. Note: Refer to localizedProperties
to get relevant attributes based on locale.
true: Attribute is inherited from its parent. <br /> false: Attribute isn't inherited from parent
Attribute type
Attribute validation - date
Date format. <br /> Applicable when attributeType is DATETIME
.
Attribute value
List of categories included
24-character system-generated category ID
Non-localized category name
true: Category name is translated into different languages or localized for different regions <br /> false: Category name isn't localized Note: Refer to localizedProperties
to get relevant details based on locale
List of categories excluded
24-character system-generated category ID
Non-localized category name
true: Category name is translated into different languages or localized for different regions <br /> false: Category name isn't localized Note: Refer to localizedProperties
to get relevant details based on locale
Attribute filters applied to the category
24-character system-generated attribute ID
Non-localized attribute name
true: Attribute name is translated into different languages or localized for different regions <br /> false: Attribute name isn't localized Note: Refer to localizedProperties
to get relevant attributes based on locale.
Filter conditions
GT
, LT
, EQUALS
, IN
, NOT_IN
, CONTAINS
, NOT_CONTAINS
Attribute value to match filter condition
Immediate children of the specified collection
24-character system-generated ID of child collection
Non-localized name of child collection
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: This is the last collection of the branch with no further children collections <br /> false: This isn't the last collection of the branch and has children collections
Email of user who last updated the category
Time of last updated to category (UTC)
Time of category creation (UTC)
Was this page helpful?