Skip to main content
PATCH
/
collections
/
{id}
curl --request PATCH \
  --url https://api.fabric.inc/v3/collections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [
    {
      "op": "replace",
      "path": "/name",
      "value": "Color"
    }
  ]
}
'
{
  "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

​
id
string
required

System-generated 24-character collection ID

Body

application/json

Collection details to be updated, including the name. Additionally, you can add, replace, or remove attributes of a collection or products associated with it.

​
data
object[]
required
Minimum array length: 1

Response

OK

Collection details

​
id
string

24-character system-generated collection ID

Example:

"55184766610c0e32a86d8759"

​
name
string

Non-localized collection name

Example:

"Color"

​
localizedProperties
object

Localized details

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

​
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

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"