Find products

To find specific products for review or reports, you need to specify the criteria for the search. With this endpoint, you can find products (items, variants, and bundles) based on ID or SKU, type, category, and other criteria.

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.

x-fabric-request-id

string

Unique request ID

Body

application/json

match

object

required

Search criteria to match attributes

Show child attributes

match.bundleProductIds

object

Simple 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

match.bundleProductIds.value

(string | null)[]

required

match.categoryId

object[]

Search by category IDs

• 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

match.categoryId.value

(string | null)[]

required

match.createdAt

object

Date-time search

• Option 1
• Option 2
• Option 3

Show child attributes

match.createdAt.fromValue

string

required

Start date for searching (UTC)

match.createdAt.op

enum<string>

required

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

Available options:

RANGE

match.createdAt.toValue

string

required

End date for searching (UTC)

match.createdBy

object

Simple 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

match.createdBy.value

(string | null)[]

required

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

match.hasDraft.value

boolean | null

required

Sample boolean schema

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

match.hasLive.value

boolean | null

required

Sample boolean schema

match.id

object

Simple 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

match.id.value

(string | null)[]

required

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

match.properties.attributeValue

object[]

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8

Show child attributes

match.properties.attributeValue.fromValue

string

required

Start date for searching (UTC)

match.properties.attributeValue.op

enum<string>

required

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

Available options:

RANGE

match.properties.attributeValue.toValue

string

required

End date for searching (UTC)

match.sku

object

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

match.sku.value

(string | null)[]

required

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

match.status.value

enum<string>

default:

LIVE

required

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

Available options:

DRAFT,

LIVE

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

match.type.value

enum<string>

required

Supported product types

Available options:

ITEM,

VARIANT,

BUNDLE

match.updatedAt

object

Date-time search

• Option 1
• Option 2
• Option 3

Show child attributes

match.updatedAt.fromValue

string

required

Start date for searching (UTC)

match.updatedAt.op

enum<string>

required

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

Available options:

RANGE

match.updatedAt.toValue

string

required

End date for searching (UTC)

match.variantIds

object

Simple 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

match.variantIds.value

(string | null)[]

required

limit

integer

default:

10

Maximum number of records per page

offset

integer

default:

0

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

sort

string

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

Response

200 - application/json

Product list by IDs

count

integer

Total number of records in the response

data

object[]

Show child attributes

data.attributes

object[]

Attributes of product

Show child attributes

data.attributes.id

string

Product ID

data.attributes.isDeleted

boolean | null

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

data.attributes.isInherited

boolean | null

true: Attributes are inherited from parent product <br /> false: Attributes aren't inherited from parent product

data.attributes.name

string

Attribute name

data.attributes.type

string

Attribute type

data.attributes.validation

object

Attribute validation - date

Show child attributes

data.attributes.validation.dateFormat

string

Date format. <br> Applicable when attributeType is DATETIME.

data.attributes.value

Attribute value

data.bundleProducts

object[]

Items or variants that are part of Bundle by ID

Show child attributes

data.bundleProducts.id

string

required

Product ID

data.bundleProducts.quantity

integer

required

Number of items or variants in bundle

data.categoryId

string

24-character system-generated category ID of product

data.createdAt

string

Time of product creation (UTC)

data.hasDraft

boolean

true: Product has a Draft version <br /> false: Product doesn't have a Draft version

data.hasLive

boolean

true: Product has a Live version <br /> false: Product doesn't have a Live version

data.id

string

Product ID

data.isActive

boolean

true: Product is active <br /> false: Product is inactive

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

data.localizedProperties.{key}.attributes.isDeleted

boolean | null

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

data.localizedProperties.{key}.attributes.isInherited

boolean | null

true: Attributes are inherited from parent product <br /> false: Attributes aren't inherited from parent product

data.localizedProperties.{key}.attributes.name

string

Attribute name

data.localizedProperties.{key}.attributes.type

string

Attribute type

data.localizedProperties.{key}.attributes.validation

object

Attribute validation - date

Show child attributes

data.localizedProperties.{key}.attributes.value

Attribute value

data.parentProduct

object

Parent item ID of the Variant

Show child attributes

data.parentProduct.id

string

Product ID

data.sku

string

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

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

data.type

enum<string>

Supported product types

Available options:

ITEM,

VARIANT,

BUNDLE

data.updatedAt

string

Time of last update to product (UTC)

data.variants

object[]

Product variants by ID

Show child attributes

data.variants.id

string

required

Product ID

limit

integer

default:

10

Maximum number of records per page

offset

integer

default:

0

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