Retrieve a product by SKU

curl --request GET \
  --url https://api.fabric.inc/v3/catalog-connector/products/skus/{skuId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'

{
  "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"
        }
      ],
      "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"
}

Operations with SKU

Retrieve a product by SKU

Use this endpoint to retrieve a single product by its SKU. You must specify the query parameters sku and locale to corresponding to the product. Optionally, you can set the following query parameters to true to refine the search results:

excludeBundleProducts: Exclude bundled products from the response.
excludeCollections: Exclude collections from the response.
excludeCategories: Exclude categories from the response.
excludeAttributes: Exclude attributes from the response.
excludeVariants: Exclude variants from the response.

If you don’t have the product SKU, use one of the endpoints to retrieve the product:

GET

catalog-connector

products

skus

{skuId}

Retrieve a product by SKU

curl --request GET \
  --url https://api.fabric.inc/v3/catalog-connector/products/skus/{skuId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'

{
  "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"
        }
      ],
      "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

Path Parameters

skuId

string

required

The Stock Keeping Unit (SKU) of a product provided by the merchant.

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.

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.

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.

Response

Option 1
Option 2
Option 3

The details of a product based on the product type.

productName

string

The name of the product.

Example:

"Nike Men's Training Shoe"

images

string[]

The list of product images.

Example:

[
  "https://myawsomestore.com/is/image/nike/8801290_s7"
]

attributes

object[]

The name of the attribute and its value.

Show child attributes

attributes.name

string

The name of the attribute.

Example:

"isOnSale"

attributes.value

The attribute value.

Example:

false

attributes.id

string

A 24-character system-generated attribute ID.

Example:

"6480216349256438cb7d53b5"

attributes.type

enum<string>

The type of attribute.

Available options:

NUMBER,

BOOLEAN,

TEXT,

LOV

Example:

"TEXT"

createdAt

string<date-time>

The time of product creation, in UTC format.

Example:

"2021-12-13T13:56:09.006Z"

updatedAt

string<date-time>

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

Example:

"2021-12-13T13:56:09.006Z"

sku

string

Product SKU

Example:

"24ggs67-e89b-12e3-a456-026614174119"

string

A 24-character system-generated ID.

Example:

"5f7329dfd5288b0011332366"

itemId

integer<int32>

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

Example:

1682313863

categoryName

string

The name of the category.

Example:

"Shoes"

categoryId

string

A 24-character system-generated category ID.

Example:

"648055dff4aa98d6c43e02da"

categories

object[]

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

Show child attributes

categories.id

string

A 24-character system-generated category ID.

Example:

"648055dff4aa98d6c43e02da"

categories.name

string

The name of the category.

Example:

"Shoes"

categories.isRoot

boolean

A flag indicating whether the given category is a root category. Set it to true if it's a root category and false if it isn't a root category.

Example:

true

categories.attributes

object[]

The details of an attribute.

Show child attributes

categories.attributes.name

string

The name of the attribute.

Example:

"isOnSale"

categories.attributes.value

The attribute value.

Example:

false

categories.attributes.id

string

A 24-character system-generated attribute ID.

Example:

"6480216349256438cb7d53b5"

categories.attributes.type

enum<string>

The type of attribute.

Available options:

NUMBER,

BOOLEAN,

TEXT,

LOV

Example:

"TEXT"

collections

object[]

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

Show child attributes

collections.id

string

A 24-character system-generated collection ID.

Example:

"648014741adc8a9de14e1a68"

collections.name

string

The name of the collection.

Example:

"Flash Sale"

collections.hierarchy

object[]

The list of collections, including their paths from the leaf collection to the root collection.

Show child attributes

collections.hierarchy.id

string

A 24-character system-generated category ID.

Example:

"648055dff4aa98d6c43e02da"

collections.hierarchy.name

string

The name of the category.

Example:

"Shoes"

collections.hierarchy.isRoot

boolean

A flag indicating whether the given category is a root category. Set it to true if it's a root category and false if it isn't a root category.

Example:

true

collections.hierarchy.attributes

object[]

The details of an attribute.

Show child attributes

collections.hierarchy.attributes.name

string

The name of the attribute.

Example:

"isOnSale"

collections.hierarchy.attributes.value

The attribute value.

Example:

false

collections.hierarchy.attributes.id

string

A 24-character system-generated attribute ID.

Example:

"6480216349256438cb7d53b5"

collections.hierarchy.attributes.type

enum<string>

The type of attribute.

Available options:

NUMBER,

BOOLEAN,

TEXT,

LOV

Example:

"TEXT"

type

enum<string>

Represents the item product type.

Available options:

ITEM

Example:

"ITEM"

variants

object[]

The details of item variants.

Show child attributes

variants.productName

string

The name of the product. The name of the product.

Example:

"Nike Men's Training Shoe"

variants.images

string[]

The list of product images. The list of product images.

Example:

[
  "https://myawsomestore.com/is/image/nike/8801290_s7"
]

variants.attributes

object[]

The name of the attribute and its value. The name of the attribute and its value.

Show child attributes

variants.attributes.name

string

The name of the attribute. The name of the attribute.

Example:

"isOnSale"

variants.attributes.value

The attribute value. The attribute value.

Example:

false

variants.attributes.id

string

A 24-character system-generated attribute ID. A 24-character system-generated attribute ID.

Example:

"6480216349256438cb7d53b5"

variants.attributes.type

enum<string>

The type of attribute. The type of attribute.

Available options:

NUMBER,

BOOLEAN,

TEXT,

LOV

Example:

"TEXT"

variants.createdAt

string<date-time>

The time of product creation, in UTC format. The time of product creation, in UTC format.

Example:

"2021-12-13T13:56:09.006Z"

variants.updatedAt

string<date-time>

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

Example:

"2021-12-13T13:56:09.006Z"

variants.sku

string

Product SKU

Example:

"24ggs67-e89b-12e3-a456-026614174119"

variants.id

string

A 24-character system-generated ID.

Example:

"5f7329dfd5288b0011332366"

variants.itemId

integer<int32>

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

Example:

1682313863

Find products Update a product by SKU

⌘I

Product Catalog

Product Catalog User Guides

Product Catalog API

Developer Guide

Catalog Connector User Guides

Catalog Connector API

Retrieve a product by SKU

Authorizations

Headers

Path Parameters

Query Parameters

Response