Find products

Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle.

• Use the CONTAINS search operation to search for products based on keywords of SKU, name, and more.
• Use the IN search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types.
• Use the less than or equals to, LTE, greater than or equals to, GTE, less than, LT, greater than, GT and equals EQ operations to search for date-specific values, such as time of creation or modification.

Authorizations

Authorization · string · header · required

This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.

Headers

x-fabric-tenant-id · string · required

A header retrieved from your Copilot Account Details that's used by the API to identify the tenant making the request. Tenant ID must be included in the authentication header for API requests to access any of fabric’s endpoints.

x-fabric-request-id · string

Unique request ID

Query Parameters

locale · string · required

The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format).

The default value is en-US.

excludeBundleProducts · boolean

A flag indicating whether the products associated with a bundle should be excluded from the response. Set it to true to exclude products of a bundle and false to include them in the response.

excludeCollections · boolean

A flag indicating whether the collections should be excluded from the response. Set it to true to exclude collections and false to include them in the response.

excludeCategories · boolean

A flag indicating whether the categories should be excluded from the response. Set it to true to exclude categories and false to include them in the response.

excludeVariants · boolean

A flag indicating whether item variants should be excluded from the response. Set it to true to exclude variants and false to include them in the response.

excludeAttributes · boolean

A flag indicating whether attributes should be excluded from the response. Set it to true to exclude attributes and false to include them in the response.

Body

application/json

search · object · required

The search criteria to find products.

Show child attributes

Example:

{
  "keyword": { "op": "CONTAINS", "value": "NIKE237765" },
  "id": {
    "op": "IN",
    "value": ["6482b9524ffa4978fd9cbf5c"]
  },
  "sku": { "op": "IN", "value": ["NIKE237765"] },
  "productName": {
    "op": "IN",
    "value": ["Nike runner shoes"]
  },
  "image": {
    "op": "IN",
    "value": [
      "https://myawsomestore.com/is/image/nike/8801290_s7"
    ]
  },
  "itemId": { "op": "IN", "value": [2700537] },
  "type": { "op": "IN", "value": ["ITEM"] },
  "parentSku": { "op": "CONTAINS", "value": "NIKE237765" },
  "parentId": {
    "op": "IN",
    "value": ["6482e47771609dfca2beb29f"]
  },
  "categoryId": {
    "op": "IN",
    "value": ["648014741adc8a9de14e1a68"]
  },
  "categoryName": { "op": "CONTAINS", "value": "Shoes" },
  "collectionName": { "op": "CONTAINS", "value": "Flash Sale" },
  "bundleProductSku": { "op": "CONTAINS", "value": "BUNDLE237765" },
  "bundleProductName": { "op": "CONTAINS", "value": "nike" },
  "bundleProductId": {
    "op": "IN",
    "value": ["60ad7e9d858eb50007abbb19#123124"]
  },
  "bundleProductCount": { "op": "GTE", "value": 10 },
  "attributes": [
    {
      "name": "Color",
      "op": "IN",
      "value": ["black"]
    }
  ],
  "attributeIds": {
    "op": "IN",
    "value": [
      "60ad7e9d858eb50007abbb19",
      "4aqz7e9d858eb5000cdeas12"
    ]
  },
  "attributeTypes": {
    "op": "IN",
    "value": ["TEXT", "BOOLEAN", "LOV", "NUMBER"]
  },
  "createdAt": {
    "op": "LTE",
    "value": "2021-12-13T13:56:09.006Z"
  },
  "updatedAt": {
    "op": "LTE",
    "value": "2021-12-13T13:56:09.006Z"
  }
}

sort · string

The sorting criteria. Currently, the supported values are sku, type, productName, itemId, categoryName, and createdAt. Use - to view the results in a descending order and + for ascending.

Example:

"+sku,-productName"

offset · integer · default: 0

The number of records to skip before returning records. For example, when the offset is 20 and limit is 10, the system returns records from 21 to 30.

Example:

2

limit · integer · default: 10

The maximum number of records per page.

Example:

10

Response

200

application/json

OK

Product Search Result list by IDs The pagination data.

offset · integer · default: 0

The number of records to skip before returning records. For example, with offset of 20 and limit of 10, the system returns the records from 21-30.

Example:

5

limit · integer · default: 10

The maximum number of records per page.

Example:

10

count · integer

The total number of records.

Example:

100

data · object[]

Option 1

Show child attributes