Create collection

POST

collections

curl --request POST \
  --url https://api.fabric.inc/v3/collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "parentCollectionId": "600f1f77bcf86cd799439011",
  "name": "Color",
  "localizedProperties": {
    "en-US": {
      "name": "Color"
    },
    "en-IN": {
      "name": "Colour"
    }
  },
  "isLocalizable": true,
  "isRoot": true,
  "isLeaf": false,
  "attributes": [
    {
      "id": "78184766610c0e32a86d8757",
      "value": "blue"
    }
  ],
  "categoryIdsIncluded": [
    "917329dfd5288b0011332300, 637329dfd5288b0011332387"
  ],
  "categoryIdsExcluded": [
    "637329dfd5288b0011332300",
    "74184766610c0e32a86d8758"
  ],
  "productAttributeFilters": [
    {
      "attributeId": "78184766610c0e32a86d8757",
      "condition": "EQUALS",
      "value": 2
    }
  ]
}'

{
  "id": "55184766610c0e32a86d8759",
  "name": "Color",
  "localizedProperties": {
    "en-US": {
      "name": "Color"
    },
    "en-IN": {
      "name": "Colour"
    }
  },
  "isLocalizable": true,
  "isRoot": true,
  "isActive": false,
  "attributes": [
    {
      "id": "64184766610c0e32a86d8758",
      "name": "color",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true,
      "isInherited": true,
      "type": "TEXT",
      "validation": {
        "dateFormat": "MM-DD-YYYY"
      },
      "value": "blue"
    }
  ],
  "categoriesIncluded": [
    {
      "id": "64184766610c0e32a86d8758",
      "name": "Chairs",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true
    }
  ],
  "categoriesExcluded": [
    {
      "id": "64184766610c0e32a86d8758",
      "name": "Chairs",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true
    }
  ],
  "productAttributeFilters": [
    {
      "attributeId": "53184766610c0e32a86d875",
      "name": "Mobile name",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true,
      "condition": "EQUALS",
      "value": 2
    }
  ],
  "children": [
    {
      "id": "78184766610c0e32a86d8757",
      "name": "Chairs",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true,
      "isLeaf": false
    }
  ],
  "updatedBy": "test@eamil.com",
  "updatedAt": "2023-04-20T10:24:36.162Z",
  "createdAt": "2021-04-20T10:24:36.162Z"
}

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.

Example:

"517fa9dfd42d8b00g1o3k312"

x-fabric-request-id

string

Unique request ID

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

Body

application/json

Details to create a collection

Collection details

parentCollectionId

string

24-character system-generated parent collection ID

Example:

"600f1f77bcf86cd799439011"

name

string

Non-localized collection name

Example:

"Color"

localizedProperties

object

localized properties of collection

Example:

{
  "en-US": { "name": "Color" },
  "en-IN": { "name": "Colour" }
}

isLocalizable

boolean

true: Collection name is translated into different languages or localized for different regions false: Collection name isn't localized. Note: Refer to localizedProperties to get relevant details based on locale

Example:

true

isRoot

boolean

true: This collection is the root branch false: This collection isn't the root branch

Example:

true

isLeaf

boolean

true: This is the last collection of the branch with no further children collections false: This isn't the last collection of the branch and has children collections

Example:

false

attributes

object[]

Collection attributes

categoryIdsIncluded

string[]

List of included category IDs

categoryIdsExcluded

string[]

deprecated

List of excluded category IDs

Example:

[
  "637329dfd5288b0011332300",
  "74184766610c0e32a86d8758"
]

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

string

24-character system-generated collection ID

Example:

"55184766610c0e32a86d8759"

name

string

Non-localized collection name

Example:

"Color"

localizedProperties

object

Localized properties of collection

Example:

{
  "en-US": { "name": "Color" },
  "en-IN": { "name": "Colour" }
}

isLocalizable

boolean

true: Collection name is translated into different languages or localized for different regions false: Collection name isn't localized Note: Refer to localizedProperties to get relevant details based on locale

Example:

true

isRoot

boolean

true: Collection is root category. false: Collection isn't a root category.

Example:

true

isActive

boolean

true: Collection is active false: Collection is inactive

Example:

false

attributes

object[]

Collection attributes

Attribute details

attributes.id

string

24-character system-generated attribute ID

Example:

"64184766610c0e32a86d8758"

attributes.name

string

Non-localized attribute name

Example:

"color"

attributes.localizedProperties

object

Localized details

Example:

{
  "en-US": { "name": "Color" },
  "en-IN": { "name": "Colour" }
}

attributes.isLocalizable

boolean

true: Attribute name can be translated into different languages or localized for different regions. false: Attribute name can't be localized. Note: Refer to localizedProperties to get relevant attributes based on locale.

Example:

true

attributes.isInherited

boolean

true: Attribute is inherited from its parent. false: Attribute isn't inherited from parent

Example:

true

attributes.type

string

Attribute type

Example:

"TEXT"

attributes.validation

object

Attribute validation - date

attributes.value

Attribute value

Example:

"blue"

categoriesIncluded

object[]

List of categories included

Category details

categoriesIncluded.id

string

24-character system-generated category ID

Example:

"64184766610c0e32a86d8758"

categoriesIncluded.name

string

Non-localized category name

Example:

"Chairs"

categoriesIncluded.localizedProperties

object

Localized properties

Example:

{
  "en-US": { "name": "Color" },
  "en-IN": { "name": "Colour" }
}

categoriesIncluded.isLocalizable

boolean

true: Category name is translated into different languages or localized for different regions false: Category name isn't localized Note: Refer to localizedProperties to get relevant details based on locale

Example:

true

categoriesExcluded

object[]

List of categories excluded

Category details

categoriesExcluded.id

string

24-character system-generated category ID

Example:

"64184766610c0e32a86d8758"

categoriesExcluded.name

string

Non-localized category name

Example:

"Chairs"

categoriesExcluded.localizedProperties

object

Localized properties

Example:

{
  "en-US": { "name": "Color" },
  "en-IN": { "name": "Colour" }
}

categoriesExcluded.isLocalizable

boolean

Example:

true

productAttributeFilters

object[]

Attribute filters applied to the category

Filter criteria

productAttributeFilters.attributeId

string

24-character system-generated attribute ID

Example:

"53184766610c0e32a86d875"

productAttributeFilters.name

string

Non-localized attribute name

Example:

"Mobile name"

productAttributeFilters.localizedProperties

object

Localized properties of attribute

Example:

{
  "en-US": { "name": "Color" },
  "en-IN": { "name": "Colour" }
}

productAttributeFilters.isLocalizable

boolean

true: Attribute name is translated into different languages or localized for different regions false: Attribute name isn't localized Note: Refer to localizedProperties to get relevant attributes based on locale.

Example:

true

productAttributeFilters.condition

enum<string>

Filter conditions

Available options:

GT,

LT,

EQUALS,

IN,

NOT_IN,

CONTAINS,

NOT_CONTAINS

Example:

"EQUALS"

productAttributeFilters.value

Attribute value to match filter condition

Example:

2

children

object[]

Immediate children of the specified collection

children.id

string

24-character system-generated ID of child collection

Example:

"78184766610c0e32a86d8757"

children.name

string

Non-localized name of child collection

Example:

"Chairs"

children.localizedProperties

object

Localized properties of child collection

Example:

{
  "en-US": { "name": "Color" },
  "en-IN": { "name": "Colour" }
}

children.isLocalizable

boolean

Example:

true

children.isLeaf

boolean

true: This is the last collection of the branch with no further children collections false: This isn't the last collection of the branch and has children collections

Example:

false

updatedBy

string

Email of user who last updated the category

Example:

"test@eamil.com"

updatedAt

string

Time of last updated to category (UTC)

Example:

"2023-04-20T10:24:36.162Z"

createdAt

string

Time of category creation (UTC)

Example:

"2021-04-20T10:24:36.162Z"

Was this page helpful?

curl --request POST \
  --url https://api.fabric.inc/v3/collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "parentCollectionId": "600f1f77bcf86cd799439011",
  "name": "Color",
  "localizedProperties": {
    "en-US": {
      "name": "Color"
    },
    "en-IN": {
      "name": "Colour"
    }
  },
  "isLocalizable": true,
  "isRoot": true,
  "isLeaf": false,
  "attributes": [
    {
      "id": "78184766610c0e32a86d8757",
      "value": "blue"
    }
  ],
  "categoryIdsIncluded": [
    "917329dfd5288b0011332300, 637329dfd5288b0011332387"
  ],
  "categoryIdsExcluded": [
    "637329dfd5288b0011332300",
    "74184766610c0e32a86d8758"
  ],
  "productAttributeFilters": [
    {
      "attributeId": "78184766610c0e32a86d8757",
      "condition": "EQUALS",
      "value": 2
    }
  ]
}'

{
  "id": "55184766610c0e32a86d8759",
  "name": "Color",
  "localizedProperties": {
    "en-US": {
      "name": "Color"
    },
    "en-IN": {
      "name": "Colour"
    }
  },
  "isLocalizable": true,
  "isRoot": true,
  "isActive": false,
  "attributes": [
    {
      "id": "64184766610c0e32a86d8758",
      "name": "color",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true,
      "isInherited": true,
      "type": "TEXT",
      "validation": {
        "dateFormat": "MM-DD-YYYY"
      },
      "value": "blue"
    }
  ],
  "categoriesIncluded": [
    {
      "id": "64184766610c0e32a86d8758",
      "name": "Chairs",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true
    }
  ],
  "categoriesExcluded": [
    {
      "id": "64184766610c0e32a86d8758",
      "name": "Chairs",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true
    }
  ],
  "productAttributeFilters": [
    {
      "attributeId": "53184766610c0e32a86d875",
      "name": "Mobile name",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true,
      "condition": "EQUALS",
      "value": 2
    }
  ],
  "children": [
    {
      "id": "78184766610c0e32a86d8757",
      "name": "Chairs",
      "localizedProperties": {
        "en-US": {
          "name": "Color"
        },
        "en-IN": {
          "name": "Colour"
        }
      },
      "isLocalizable": true,
      "isLeaf": false
    }
  ],
  "updatedBy": "test@eamil.com",
  "updatedAt": "2023-04-20T10:24:36.162Z",
  "createdAt": "2021-04-20T10:24:36.162Z"
}

Release Notes

Authorizations

Headers

Body

Response