Create collection
Collection is an alternative way to organize products compared to the Category system, which is the original organization of items. Because the Category system isn’t granular enough to meet all the requirements of Storefronts, collections are used to organize products as per the merchant’s requirements. This endpoint is used to create a new collection within the alternative organization so that it can be adapted to support various use-cases of Storefronts.
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
Collection details
24-character system-generated parent collection ID
Non-localized collection name
localized properties of 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 collection is the root branch <br /> false: This collection isn't the root branch
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
Collection attributes
List of excluded category IDs
Details of attribute filters applied. In the Create collection endpoint, it's also used to create collection based on attribute values. For example, create collection for mobile phones, where price is greater than 25000
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?