POST
/
collections

Authorizations

Authorization
string
headerrequired

S2S access token (JWT) from fabric Identity service (during Login)

Headers

x-fabric-tenant-id
string

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.

x-fabric-request-id
string

Unique request ID

Body

application/json

Collection details

parentCollectionId
string

24-character system-generated parent collection ID

name
string

Non-localized collection name

localizedProperties
object

localized properties of collection

isLocalizable
boolean

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

isRoot
boolean

true: This collection is the root branch <br /> false: This collection isn't the root branch

isLeaf
boolean

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

attributes
object[]

Collection attributes

categoryIdsIncluded
string[]
categoryIdsExcluded
string[]
deprecated

List of excluded category IDs

productAttributeFilters
object[]

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

200 - application/json

Collection details

id
string

24-character system-generated collection ID

name
string

Non-localized collection name

localizedProperties
object

Localized details

isLocalizable
boolean

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

isRoot
boolean

true: Collection is root category.<br /> false: Collection isn't a root category.

isActive
boolean

true: Collection is active <br /> false: Collection is inactive

attributes
object[]

Collection attributes

categoriesIncluded
object[]

List of categories included

categoriesExcluded
object[]

List of categories excluded

productAttributeFilters
object[]

Attribute filters applied to the category

children
object[]

Immediate children of the specified collection

updatedBy
string

Email of user who last updated the category

updatedAt
string

Time of last updated to category (UTC)

createdAt
string

Time of category creation (UTC)