Update Collection

curl --request PUT \
  --url https://api.fabric.inc/v3/collections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Color",
  "isLocalizable": true,
  "localizedProperties": {
    "en-US": {
      "name": "Color"
    },
    "en-IN": {
      "name": "Colour"
    }
  },
  "attributes": [
    {
      "id": "78184766610c0e32a86d8757",
      "value": "blue"
    }
  ],
  "categoryIdsIncluded": [
    "64184766610c0e32a86d8758",
    "917329dfd5288b0011332300"
  ],
  "categoryIdsExcluded": [
    "66184766610c0e32a86d8722",
    "41184766610c0e32a86d8778"
  ],
  "isActive": true,
  "productAttributeFilters": [
    {
      "attributeId": "53184766610c0e32a86d875",
      "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": "[email protected]",
  "updatedAt": "2023-04-20T10:24:36.162Z",
  "createdAt": "2021-04-20T10:24:36.162Z"
}

PUT

collections

{id}

Update Collection

curl --request PUT \
  --url https://api.fabric.inc/v3/collections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Color",
  "isLocalizable": true,
  "localizedProperties": {
    "en-US": {
      "name": "Color"
    },
    "en-IN": {
      "name": "Colour"
    }
  },
  "attributes": [
    {
      "id": "78184766610c0e32a86d8757",
      "value": "blue"
    }
  ],
  "categoryIdsIncluded": [
    "64184766610c0e32a86d8758",
    "917329dfd5288b0011332300"
  ],
  "categoryIdsExcluded": [
    "66184766610c0e32a86d8722",
    "41184766610c0e32a86d8778"
  ],
  "isActive": true,
  "productAttributeFilters": [
    {
      "attributeId": "53184766610c0e32a86d875",
      "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": "[email protected]",
  "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"

Path Parameters

string

required

System-generated 24-character collection ID

Body

application/json

Details to update collection

name

string

Non-localized collection name

Example:

"Color"

isLocalizable

boolean

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

Example:

true

localizedProperties

object

Localized properties of collection

Show child attributes

localizedProperties.{key}

object

Show child attributes

localizedProperties.{key}.name

string

Localized name

Example:

"Color"

Example:

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

attributes

object[]

List of attributes assigned to the collection

Show child attributes

attributes.id

string

24-character system-generated attribute ID

Example:

"78184766610c0e32a86d8757"

attributes.value

Attribute value

Example:

"blue"

categoryIdsIncluded

string[]

Category IDs included in collection

Example:

[
  "64184766610c0e32a86d8758",
  "917329dfd5288b0011332300"
]

categoryIdsExcluded

string[]

deprecated

Category IDs excluded in collection

Example:

[
  "66184766610c0e32a86d8722",
  "41184766610c0e32a86d8778"
]

isActive

boolean

true: Collection is active
false: Collection is inactive

Example:

true

productAttributeFilters

object[]

Show child attributes

productAttributeFilters.attributeId

string

24-character system-generated attribute ID

Example:

"53184766610c0e32a86d875"

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

Response

Collection details

string

24-character system-generated collection ID

Example:

"55184766610c0e32a86d8759"

name

string

Non-localized collection name

Example:

"Color"

localizedProperties

object

Localized details

Show child attributes

localizedProperties.{key}

object

Show child attributes

localizedProperties.{key}.name

string

Localized name

Example:

"Color"

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

Show child attributes

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

Show child attributes

attributes.localizedProperties.{key}

object

Show child attributes

attributes.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

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

Show child attributes

attributes.validation.dateFormat

string

Date format.
Applicable when attributeType is DATETIME.

Example:

"MM-DD-YYYY"

attributes.value

Attribute value

Example:

"blue"

categoriesIncluded

object[]

List of categories included

Show child attributes

categoriesIncluded.id

string

24-character system-generated category ID

Example:

"64184766610c0e32a86d8758"

categoriesIncluded.name

string

Non-localized category name

Example:

"Chairs"

categoriesIncluded.localizedProperties

object

Localized details

Show child attributes

categoriesIncluded.localizedProperties.{key}

object

Show child attributes

categoriesIncluded.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

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

Show child attributes

categoriesExcluded.id

string

24-character system-generated category ID

Example:

"64184766610c0e32a86d8758"

categoriesExcluded.name

string

Non-localized category name

Example:

"Chairs"

categoriesExcluded.localizedProperties

object

Localized details

Show child attributes

categoriesExcluded.localizedProperties.{key}

object

Show child attributes

categoriesExcluded.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

Example:

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

categoriesExcluded.isLocalizable

boolean

Example:

true

productAttributeFilters

object[]

Attribute filters applied to the category

Show child attributes

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

Show child attributes

productAttributeFilters.localizedProperties.{key}

object

Show child attributes

productAttributeFilters.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

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

Show child attributes

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 details

Show child attributes

children.localizedProperties.{key}

object

Show child attributes

children.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

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:

"[email protected]"

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"

Create Multiple Collections Partially Update Collection

⌘I

Product Catalog

Product Catalog User Guides

Product Catalog API

Developer Guide

Catalog Connector User Guides

Catalog Connector API

Update Collection

Authorizations

Headers

Path Parameters

Body

Response