Operations

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.

POST

catalog-connector

products

curl --request POST \
  --url https://api.fabric.inc/v3/catalog-connector/products/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "sort": "+sku,-productName",
  "search": {
    "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"
    }
  },
  "offset": 2,
  "limit": 10
}'

{
  "offset": 0,
  "limit": 10,
  "count": 1,
  "data": [
    {
      "sku": "NIKE237765",
      "productName": "Nike runner shoes",
      "id": "6482b9524ffa4978fd9cbf5c",
      "itemId": 2700537,
      "categoryName": "Sport Shoes",
      "categoryId": "648014741adc8a9de14e1a68",
      "images": [
        "https://myawsomestore.com/is/image/nike/8801290_s7"
      ],
      "attributes": [
        {
          "name": "Color",
          "value": "black",
          "id": "6480216349256438cb7d53b5",
          "type": "TEXT"
        },
        {
          "name": "Wide Fit",
          "value": false,
          "id": "640db94f9fc28b255d155a42",
          "type": "BOOLEAN"
        }
      ],
      "type": "ITEM",
      "variants": [
        {
          "sku": "NIKE237766",
          "productName": "Nike runner white shoes",
          "id": "648aa9280d7b561b4663038c",
          "itemId": 2700538,
          "images": [
            "https://myawsomestore.com/is/image/nike/8801291_s7"
          ],
          "attributes": [
            {
              "name": "Color",
              "value": "White",
              "id": "6480216349256438cb7d53b5",
              "type": "TEXT"
            },
            {
              "name": "Wide Fit",
              "value": true,
              "id": "640db94f9fc28b255d155a42",
              "type": "BOOLEAN"
            },
            {
              "name": "Brand",
              "value": [
                "Nike"
              ],
              "id": "640db94f9fc28b255d155a42",
              "type": "LOV"
            }
          ],
          "createdAt": "2021-12-13T13:56:09.006Z",
          "updatedAt": "2021-12-13T13:56:09.006Z"
        }
      ],
      "categories": [
        {
          "name": "Sport Shoes",
          "id": "648014741adc8a9de14e1a68",
          "isRoot": false,
          "attributes": [
            {
              "name": "Fit",
              "value": "Relaxed Fit",
              "id": "648014741adc8a9de14e1a00",
              "type": "TEXT"
            }
          ]
        },
        {
          "name": "Shoes",
          "id": "648aa9258fdef29675dbce42",
          "isRoot": true,
          "attributes": [
            {
              "name": "Material",
              "value": "Mesh"
            }
          ]
        }
      ],
      "collections": [
        {
          "name": "Flash sale",
          "id": "648055dff4aa98d6c43e02da",
          "hierarchy": [
            {
              "name": "Flash Sale",
              "id": "648055dff4aa98d6c43e02da",
              "isRoot": false,
              "attributes": [
                {
                  "name": "Duration",
                  "value": 600,
                  "type": "NUMBER"
                }
              ]
            },
            {
              "name": "Sales",
              "id": "648055e0f4aa98d6c43e02f7",
              "isRoot": true
            }
          ]
        }
      ],
      "createdAt": "2021-12-13T13:56:09.006Z",
      "updatedAt": "2021-12-13T13:56:09.006Z"
    }
  ]
}

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

object

required

The search criteria to find products.

search.keyword

object

The search criteria based on keywords of product name, SKU, item ID, more.

search.id

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.sku

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.productName

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.image

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.itemId

object

The search criteria based on integer values.

search.type

object

The search criteria based on product type.

search.parentSku

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.categoryId

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.categoryName

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.collectionId

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.collectionName

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.bundleProductName

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.bundleProductSku

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.bundleProductCount

object

The search criteria based on integer values.

search.variantProductName

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.variantProductSku

object

The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.

search.attributes

object[]

search.createdAt

object

The search criteria based on date-time using the IN condition.

search.updatedAt

object

The search criteria based on date-time using the IN condition.

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.

offset

integer

default:

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.

limit

integer

default:

The maximum number of records per page.

Response

200

application/json

Product Search Result list by IDs

offset

integer

default:

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.

limit

integer

default:

The maximum number of records per page.

count

integer

The total number of records.

data

object[]

data.productName

string

The name of the product.

data.images

string[]

The list of product images.

data.attributes

object[]

The name of the attribute and its value.

data.createdAt

string

The time of product creation, in UTC format.

data.updatedAt

string

The time of last update to product, in UTC format.

data.sku

string

Product SKU

data.id

string

A 24-character system-generated ID.

data.itemId

integer

A unique identifier of an item, a variant or a bundle.

data.categoryName

string

The name of the category.

data.categoryId

string

A 24-character system-generated category ID.

data.categories

object[]

The list of categories, including their paths from the leaf category to the root category.

data.collections

object[]

The details of the collection used to display products on the storefront.

data.type

enum<string>

Represents the item product type.

Available options:

ITEM

data.variants

object[]

The details of item variants.

Was this page helpful?

Retrieve jobs Retrieve a product by SKU

curl --request POST \
  --url https://api.fabric.inc/v3/catalog-connector/products/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "sort": "+sku,-productName",
  "search": {
    "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"
    }
  },
  "offset": 2,
  "limit": 10
}'

{
  "offset": 0,
  "limit": 10,
  "count": 1,
  "data": [
    {
      "sku": "NIKE237765",
      "productName": "Nike runner shoes",
      "id": "6482b9524ffa4978fd9cbf5c",
      "itemId": 2700537,
      "categoryName": "Sport Shoes",
      "categoryId": "648014741adc8a9de14e1a68",
      "images": [
        "https://myawsomestore.com/is/image/nike/8801290_s7"
      ],
      "attributes": [
        {
          "name": "Color",
          "value": "black",
          "id": "6480216349256438cb7d53b5",
          "type": "TEXT"
        },
        {
          "name": "Wide Fit",
          "value": false,
          "id": "640db94f9fc28b255d155a42",
          "type": "BOOLEAN"
        }
      ],
      "type": "ITEM",
      "variants": [
        {
          "sku": "NIKE237766",
          "productName": "Nike runner white shoes",
          "id": "648aa9280d7b561b4663038c",
          "itemId": 2700538,
          "images": [
            "https://myawsomestore.com/is/image/nike/8801291_s7"
          ],
          "attributes": [
            {
              "name": "Color",
              "value": "White",
              "id": "6480216349256438cb7d53b5",
              "type": "TEXT"
            },
            {
              "name": "Wide Fit",
              "value": true,
              "id": "640db94f9fc28b255d155a42",
              "type": "BOOLEAN"
            },
            {
              "name": "Brand",
              "value": [
                "Nike"
              ],
              "id": "640db94f9fc28b255d155a42",
              "type": "LOV"
            }
          ],
          "createdAt": "2021-12-13T13:56:09.006Z",
          "updatedAt": "2021-12-13T13:56:09.006Z"
        }
      ],
      "categories": [
        {
          "name": "Sport Shoes",
          "id": "648014741adc8a9de14e1a68",
          "isRoot": false,
          "attributes": [
            {
              "name": "Fit",
              "value": "Relaxed Fit",
              "id": "648014741adc8a9de14e1a00",
              "type": "TEXT"
            }
          ]
        },
        {
          "name": "Shoes",
          "id": "648aa9258fdef29675dbce42",
          "isRoot": true,
          "attributes": [
            {
              "name": "Material",
              "value": "Mesh"
            }
          ]
        }
      ],
      "collections": [
        {
          "name": "Flash sale",
          "id": "648055dff4aa98d6c43e02da",
          "hierarchy": [
            {
              "name": "Flash Sale",
              "id": "648055dff4aa98d6c43e02da",
              "isRoot": false,
              "attributes": [
                {
                  "name": "Duration",
                  "value": 600,
                  "type": "NUMBER"
                }
              ]
            },
            {
              "name": "Sales",
              "id": "648055e0f4aa98d6c43e02f7",
              "isRoot": true
            }
          ]
        }
      ],
      "createdAt": "2021-12-13T13:56:09.006Z",
      "updatedAt": "2021-12-13T13:56:09.006Z"
    }
  ]
}

Product Catalog User Guides

Catalog Connector User Guides

Product Catalog API

Catalog Connector API

Find products

Authorizations

Headers

Query Parameters

Body

Response