Retrieve a product or a variant by Item ID

Use this endpoint to retrieve a single product by its itemId. You must specify the query parameters itemId and locale. Optionally, you can set the following query parameters to true to refine the search results: You must specify the query parameters itemId and locale. 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 itemId, use one of the endpoints to retrieve the product:

• Update a product by SKU.
• Update a product by product ID.

GET /catalog-connector/products/itemIds/{itemId}

Retrieve a product or a variant by Item ID

cURL

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

200

Product

{
  "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

itemId · integer<int32> · required

A sequential system-generated item 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.

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

200

application/json

OK

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

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"

id · 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

collections · object[]

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

Show child attributes

type · enum<string>

Represents the item product type.

Available options: ITEM

Example:

"ITEM"

variants · object[]

The details of item variants.

Show child attributes