Find Collections

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

Request body for search

match

object

required

Specification for matching attributes

Show child attributes

match.id

object

Simple string search Multi-string search

Option 1
Option 2

Show child attributes

match.id.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.id.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.name

object

Searches for attributes that matches the query. Append locale and name with a # as a value String search Multi-string search

Option 1
Option 2

Show child attributes

match.name.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.name.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.name.locale

string[]

If isLocalizable is true, searches for the requested name in the list of locales provided here. If isLocalizable is false, searches for the non-localized names.

Locale

match.isLocalizable

object

Boolean search

Show child attributes

match.isLocalizable.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.isLocalizable.value

boolean | null

required

Sample boolean schema

Example:

true

match.isRoot

object

Boolean search

Show child attributes

match.isRoot.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.isRoot.value

boolean | null

required

Sample boolean schema

Example:

true

match.isLeaf

object

Boolean search

Show child attributes

match.isLeaf.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.isLeaf.value

boolean | null

required

Sample boolean schema

Example:

true

match.attribute

object[]

Show child attributes

match.attribute.id

string

24-character system-generated attribute ID

Example:

"60184766610c0e32a86d8758"

match.attribute.value

object[]

Attribute value

Search criteria based on localized data Advanced string search Advanced multi-string search

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

match.attribute.value.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN,

NOT_IN

Example:

"IN"

match.attribute.value.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.attribute.value.locale

string

If isLocalizable is true, searches for the requested name in the list of locales provided here. If isLocalizable is false, searches for the non-localized names.

Example:

"en_US"

match.categoryIdsIncluded

object

Simple string search Multi-string search

Option 1
Option 2

Show child attributes

match.categoryIdsIncluded.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.categoryIdsIncluded.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.categoryIdsExcluded

object

deprecated

Simple string search Multi-string search

Option 1
Option 2

Show child attributes

match.categoryIdsExcluded.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.categoryIdsExcluded.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.productAttributeIdsFilter

object

Simple string search Multi-string search

Option 1
Option 2

Show child attributes

match.productAttributeIdsFilter.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.productAttributeIdsFilter.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.updatedBy

object

Simple string search Multi-string search

Option 1
Option 2

Show child attributes

match.updatedBy.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.updatedBy.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.createdAt

object

Date-time search Date range search

Option 1
Option 2
Option 3

Show child attributes

match.createdAt.op

enum<string>

required

Search operation performed on a date range

Available options:

RANGE

Example:

"RANGE"

match.createdAt.fromValue

string

required

Starting range (UTC)

Example:

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

match.createdAt.toValue

string

required

Ending range (UTC)

Example:

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

match.updatedAt

object

Date-time search Date range search

Option 1
Option 2
Option 3

Show child attributes

match.updatedAt.op

enum<string>

required

Search operation performed on a date range

Available options:

RANGE

Example:

"RANGE"

match.updatedAt.fromValue

string

required

Starting range (UTC)

Example:

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

match.updatedAt.toValue

string

required

Ending range (UTC)

Example:

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

sort

string

Sorting criteria. Sorting is supported only on createdAt, updatedAt. - refers to descending while + refers to ascending order

Example:

"+createdAt,-updatedAt"

offset

integer<int32>

default:0

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

Example:

2

limit

integer<int32>

default:10

Maximum number of records per page

Example:

10

Response

Search response

offset

integer<int32>

default:0

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

Example:

5

limit

integer<int32>

default:10

Maximum number of records per page

Example:

10

count

integer<int32>

Total number of records in the response

Example:

100

data

object[]

Show child attributes

data.id

string

24-character system-generated collection ID

Example:

"55184766610c0e32a86d8759"

data.name

string

Non-localized collection name

Example:

"Color"

data.localizedProperties

object

Localized details

Show child attributes

data.localizedProperties.{key}

object

Show child attributes

data.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

Example:

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

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

data.isRoot

boolean

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

Example:

true

data.isActive

boolean

true: Collection is active
false: Collection is inactive

Example:

false

data.attributes

object[]

Collection attributes

Show child attributes

data.attributes.id

string

24-character system-generated attribute ID

Example:

"64184766610c0e32a86d8758"

data.attributes.name

string

Non-localized attribute name

Example:

"color"

data.attributes.localizedProperties

object

Localized details

Show child attributes

data.attributes.localizedProperties.{key}

object

Show child attributes

data.attributes.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

Example:

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

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

data.attributes.isInherited

boolean

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

Example:

true

data.attributes.type

string

Attribute type

Example:

"TEXT"

data.attributes.validation

object

Attribute validation - date

Show child attributes

data.attributes.validation.dateFormat

string

Date format.
Applicable when attributeType is DATETIME.

Example:

"MM-DD-YYYY"

data.attributes.value

Attribute value

Example:

"blue"

data.categoriesIncluded

object[]

List of categories included

Show child attributes

data.categoriesIncluded.id

string

24-character system-generated category ID

Example:

"64184766610c0e32a86d8758"

data.categoriesIncluded.name

string

Non-localized category name

Example:

"Chairs"

data.categoriesIncluded.localizedProperties

object

Localized details

Show child attributes

data.categoriesIncluded.localizedProperties.{key}

object

Show child attributes

data.categoriesIncluded.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

Example:

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

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

data.categoriesExcluded

object[]

List of categories excluded

Show child attributes

data.categoriesExcluded.id

string

24-character system-generated category ID

Example:

"64184766610c0e32a86d8758"

data.categoriesExcluded.name

string

Non-localized category name

Example:

"Chairs"

data.categoriesExcluded.localizedProperties

object

Localized details

Show child attributes

data.categoriesExcluded.localizedProperties.{key}

object

Show child attributes

data.categoriesExcluded.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

Example:

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

data.categoriesExcluded.isLocalizable

boolean

Example:

true

data.productAttributeFilters

object[]

Attribute filters applied to the category

Show child attributes

data.productAttributeFilters.attributeId

string

24-character system-generated attribute ID

Example:

"53184766610c0e32a86d875"

data.productAttributeFilters.name

string

Non-localized attribute name

Example:

"Mobile name"

data.productAttributeFilters.localizedProperties

object

Localized properties of attribute

Show child attributes

data.productAttributeFilters.localizedProperties.{key}

object

Show child attributes

data.productAttributeFilters.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

Example:

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

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

data.productAttributeFilters.condition

enum<string>

Filter conditions

Available options:

GT,

LT,

EQUALS,

IN,

NOT_IN,

CONTAINS,

NOT_CONTAINS

Example:

"EQUALS"

data.productAttributeFilters.value

Attribute value to match filter condition

Example:

2

data.children

object[]

Immediate children of the specified collection

Show child attributes

data.children.id

string

24-character system-generated ID of child collection

Example:

"78184766610c0e32a86d8757"

data.children.name

string

Non-localized name of child collection

Example:

"Chairs"

data.children.localizedProperties

object

Localized details

Show child attributes

data.children.localizedProperties.{key}

object

Show child attributes

data.children.localizedProperties.{key}.name

string

Localized name

Example:

"Color"

Example:

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

data.children.isLocalizable

boolean

Example:

true

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

data.updatedBy

string

Email of user who last updated the category

Example:

"[email protected]"

data.updatedAt

string

Time of last updated to category (UTC)

Example:

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

data.createdAt

string

Time of category creation (UTC)

Example:

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

Product Catalog

Product Catalog User Guides

Product Catalog API

Developer Guide

Catalog Connector User Guides

Catalog Connector API

Find Collections

Authorizations

Headers

Body

Response