Find Products

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

match

object

required

Search criteria to match attributes

Show child attributes

match.id

object

Simple string search Advanced single-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.sku

object

String search Advanced single-string search

Option 1
Option 2

Show child attributes

match.sku.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.sku.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.type

object

Attributes that match the search query using single product type

Option 1
Option 2

Show child attributes

match.type.op

enum<string>

required

Operations that can be performed on a string type.

Available options:

EQUALS

Example:

"EQUALS"

match.type.value

enum<string>

required

Supported product types

Available options:

ITEM,

VARIANT,

BUNDLE

Example:

"ITEM"

match.hasDraft

object

Boolean search

Show child attributes

match.hasDraft.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.hasDraft.value

boolean | null

required

Sample boolean schema

Example:

true

match.hasLive

object

Boolean search

Show child attributes

match.hasLive.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.hasLive.value

boolean | null

required

Sample boolean schema

Example:

true

match.status

object

Attributes that match the search query using single status

Show child attributes

match.status.op

enum<string>

required

Operations that can be performed on a single-status

Available options:

EQUALS

Example:

"EQUALS"

match.status.value

enum<string>

default:LIVE

required

Statuses indicating the product version considered for this operation. For example,
1. When the status is DRAFT, this operations will only apply to the Draft version of product, if it exists
2. When the status is LIVE, this operation will only apply to the Live version of the product.

Available options:

DRAFT,

LIVE

Example:

"LIVE"

match.categoryId

object[]

Search by category IDs

Advanced multi-string search

Option 1
Option 2

Show child attributes

match.categoryId.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN,

NOT_IN

Example:

"IN"

match.categoryId.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.properties

object[]

Product Attributes are searched with the combination of id and value. Multiple attributes can be included in the search

Show child attributes

match.properties.attributeId

string

Attribute ID

Example:

"CAZZX1234567DDDDD"

match.properties.attributeValue

object[]

Product attribute value

Show child attributes

match.properties.attributeValue.op

enum<string>

required

Search operation that can be performed on a date-time range type

Available options:

RANGE

Example:

"RANGE"

match.properties.attributeValue.fromValue

string

required

Start date for searching (UTC)

Example:

"2022-09-14T22:10:30.618Z"

match.properties.attributeValue.toValue

string

required

End date for searching (UTC)

Example:

"2023-04-14T22:10:30.618Z"

match.variantIds

object

Simple string search Advanced single-string search

Option 1
Option 2

Show child attributes

match.variantIds.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.variantIds.value

(string | null)[]

required

Sample string schema

Example:

"blue"

match.bundleProductIds

object

Simple string search Advanced single-string search

Option 1
Option 2

Show child attributes

match.bundleProductIds.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.bundleProductIds.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 that can be performed on a date-time range type

Available options:

RANGE

Example:

"RANGE"

match.createdAt.fromValue

string

required

Start date for searching (UTC)

Example:

"2022-09-14T22:10:30.618Z"

match.createdAt.toValue

string

required

End date for searching (UTC)

Example:

"2023-04-14T22:10:30.618Z"

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 that can be performed on a date-time range type

Available options:

RANGE

Example:

"RANGE"

match.updatedAt.fromValue

string

required

Start date for searching (UTC)

Example:

"2022-09-14T22:10:30.618Z"

match.updatedAt.toValue

string

required

End date for searching (UTC)

Example:

"2023-04-14T22:10:30.618Z"

match.createdBy

object

Simple string search Advanced single-string search

Option 1
Option 2

Show child attributes

match.createdBy.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.createdBy.value

(string | null)[]

required

Sample string schema

Example:

"blue"

sort

string

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

Example:

"+sku,-name"

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

Product list by IDs

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

Product ID

Example:

"AASSBCC12334FCD12334V"

data.sku

string

Unique product ID that maps to fabric's standard attribute called SKU.
Note: sku shouldn't include ; or =

Example:

"XP-123345"

data.type

enum<string>

Supported product types

Available options:

ITEM,

VARIANT,

BUNDLE

Example:

"ITEM"

data.isActive

boolean

true: Product is active
false: Product is inactive

Example:

true

data.hasDraft

boolean

true: Product has a Draft version
false: Product doesn't have a Draft version

Example:

true

data.hasLive

boolean

true: Product has a Live version
false: Product doesn't have a Live version

Example:

true

data.status

enum<string>

Represents the current status of product. This value takes precedence over isActive if both are sent in the request.

Available options:

DRAFT,

LIVE

Example:

"LIVE"

data.attributes

object[]

Attributes of product

Show child attributes

data.attributes.id

string

Product ID

Example:

"AASSBCC12334FCD12334V"

data.attributes.name

string

Attribute name

Example:

"color"

data.attributes.type

string

Attribute type

Example:

"string"

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

boolean | null

true: Attributes are inherited from parent product
false: Attributes aren't inherited from parent product Note: Attributes are soft deleted when a product is moved from one category to another.

Example:

false

data.attributes.isInherited

boolean | null

true: Attributes are inherited from parent product
false: Attributes aren't inherited from parent product

Example:

true

data.attributes.value

Attribute value

Example:

"blue"

data.localizedProperties

object

Localized attribute names

Show child attributes

data.localizedProperties.{key}

object

Show child attributes

data.localizedProperties.{key}.attributes

object[]

Show child attributes

data.localizedProperties.{key}.attributes.id

string

Product ID

Example:

"AASSBCC12334FCD12334V"

data.localizedProperties.{key}.attributes.name

string

Attribute name

Example:

"color"

data.localizedProperties.{key}.attributes.type

string

Attribute type

Example:

"string"

data.localizedProperties.{key}.attributes.validation

object

Attribute validation - date

Show child attributes

data.localizedProperties.{key}.attributes.validation.dateFormat

string

Date format.
Applicable when attributeType is DATETIME.

Example:

"MM-DD-YYYY"

data.localizedProperties.{key}.attributes.isDeleted

boolean | null

true: Attributes are inherited from parent product
false: Attributes aren't inherited from parent product Note: Attributes are soft deleted when a product is moved from one category to another.

Example:

false

data.localizedProperties.{key}.attributes.isInherited

boolean | null

true: Attributes are inherited from parent product
false: Attributes aren't inherited from parent product

Example:

true

data.localizedProperties.{key}.attributes.value

Attribute value

Example:

"blue"

Example:

{
  "en-US": {
    "attributes": [
      {
        "id": "4e7329dfd5288b0011332366",
        "name": "Color",
        "type": "string",
        "isDeleted": false,
        "value": "blue",
        "isInherited": true
      }
    ]
  }
}

data.parentProduct

object

Parent item ID of the Variant

Show child attributes

data.parentProduct.id

string

Product ID

Example:

"AASSBCC12334FCD12334V"

data.variants

object[]

Product variants by ID

Show child attributes

data.variants.id

string

required

Product ID

Example:

"AASSBCC12334FCD12334V"

data.categoryId

string

24-character system-generated category ID of product

Example:

"6h7329dfd5288b001133231d"

data.bundleProducts

object[]

Items or variants that are part of Bundle by ID

Show child attributes

data.bundleProducts.id

string

required

Product ID

Example:

"AASSBCC12334FCD12334V"

data.bundleProducts.quantity

integer<int32>

required

Number of items or variants in bundle

Example:

2

data.createdAt

string

Time of product creation (UTC)

Example:

"2021-09-14T22:10:30.618Z"

data.updatedAt

string

Time of last update to product (UTC)

Example:

"2021-09-14T22:10:30.618Z"

Product Catalog

Product Catalog User Guides

Product Catalog API

Developer Guide

Catalog Connector User Guides

Catalog Connector API

Authorizations

Headers

Body

Response