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

Authorization

string

header

required

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

attributes

object[]

Collection attributes

Show child attributes

attributes.id

string

24-character system-generated attribute ID

attributes.value

Attribute value

categoryIdsExcluded

string[]

deprecated

List of excluded category IDs

categoryIdsIncluded

string[]

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

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

localizedProperties

object

localized properties of collection

Show child attributes

localizedProperties.{key}

object

Show child attributes

localizedProperties.{key}.name

string

Localized name

name

string

Non-localized collection name

parentCollectionId

string

24-character system-generated parent collection ID

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

Show child attributes

productAttributeFilters.attributeId

string

24-character system-generated attribute ID

productAttributeFilters.condition

enum<string>

Filter conditions

Available options:

GT,

LT,

EQUALS,

IN,

NOT_IN,

CONTAINS,

NOT_CONTAINS

productAttributeFilters.value

Attribute value to match filter condition

Response

200 - application/json

Collection details

attributes

object[]

Collection attributes

Show child attributes

attributes.id

string

24-character system-generated attribute ID

attributes.isInherited

boolean

true: Attribute is inherited from its parent. <br /> false: Attribute isn't inherited from parent

attributes.isLocalizable

boolean

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.

attributes.localizedProperties

object

Localized details

Show child attributes

attributes.localizedProperties.{key}

object

Show child attributes

attributes.localizedProperties.{key}.name

string

Localized name

attributes.name

string

Non-localized attribute name

attributes.type

string

Attribute type

attributes.validation

object

Attribute validation - date

Show child attributes

attributes.validation.dateFormat

string

Date format. <br /> Applicable when attributeType is DATETIME.

attributes.value

Attribute value

categoriesExcluded

object[]

List of categories excluded

Show child attributes

categoriesExcluded.id

string

24-character system-generated category ID

categoriesExcluded.isLocalizable

boolean

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

categoriesExcluded.localizedProperties

object

Localized details

Show child attributes

categoriesExcluded.localizedProperties.{key}

object

Show child attributes

categoriesExcluded.localizedProperties.{key}.name

string

Localized name

categoriesExcluded.name

string

Non-localized category name

categoriesIncluded

object[]

List of categories included

Show child attributes

categoriesIncluded.id

string

24-character system-generated category ID

categoriesIncluded.isLocalizable

boolean

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

categoriesIncluded.localizedProperties

object

Localized details

Show child attributes

categoriesIncluded.localizedProperties.{key}

object

Show child attributes

categoriesIncluded.localizedProperties.{key}.name

string

Localized name

categoriesIncluded.name

string

Non-localized category name

children

object[]

Immediate children of the specified collection

Show child attributes

children.id

string

24-character system-generated ID of child collection

children.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

children.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

children.localizedProperties

object

Localized details

Show child attributes

children.localizedProperties.{key}

object

Show child attributes

children.localizedProperties.{key}.name

string

Localized name

children.name

string

Non-localized name of child collection

createdAt

string

Time of category creation (UTC)

id

string

24-character system-generated collection ID

isActive

boolean

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

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.

localizedProperties

object

Localized details

Show child attributes

localizedProperties.{key}

object

Show child attributes

localizedProperties.{key}.name

string

Localized name

name

string

Non-localized collection name

productAttributeFilters

object[]

Attribute filters applied to the category

Show child attributes

productAttributeFilters.attributeId

string

24-character system-generated attribute ID

productAttributeFilters.condition

enum<string>

Filter conditions

Available options:

GT,

LT,

EQUALS,

IN,

NOT_IN,

CONTAINS,

NOT_CONTAINS

productAttributeFilters.isLocalizable

boolean

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.

productAttributeFilters.localizedProperties

object

Localized properties of attribute

Show child attributes

productAttributeFilters.localizedProperties.{key}

object

Show child attributes

productAttributeFilters.localizedProperties.{key}.name

string

Localized name

productAttributeFilters.name

string

Non-localized attribute name

productAttributeFilters.value

Attribute value to match filter condition

updatedAt

string

Time of last updated to category (UTC)

updatedBy

string

Email of user who last updated the category