POST
/
catalog-connector
/
products
curl --request POST \
  --url https://api.fabric.inc/v3/catalog-connector/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "sku": "NIKE237765",
  "productName": "Nike runner shoes",
  "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
        }
      ]
    }
  ]
}'
{
  "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

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.

Body

application/json

A sample request to create a new product. A sample request to create a product of the type item. A sample request to update an item. A sample request to update a product with common properties. A common schema for product, variants, and bundles.

​
sku
string
required

Product SKU

Example:

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

​
type
enum<string>

Represents the item product type.

Available options:
ITEM
Example:

"ITEM"

​
variants
object[]

The details of the item variants.

​
categoryName
string

The name of the category. This value is overridden if the categories are populated.

Example:

"Sport Shoes"

​
categoryId
string

A 24-character system-generated ID of the category.

Example:

"648014741adc8a9de14e1a68"

​
categories
object[]

The category details, including their paths from the leaf category to the root category.

Example:
[
  {
    "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
object[]

The details of the collection.

Example:
[
  {
    "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
      }
    ]
  }
]
​
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.

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

Response

OK.

The details of a product based on the product type. The details of an item. Additional details of a product. A common schema for product, variants, and bundles along with their identifiers. A common schema for product, variants, and bundles.

​
type
enum<string>

Represents the item product type.

Available options:
ITEM
Example:

"ITEM"

​
variants
object[]

The details of item variants.

​
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.

​
collections
object[]

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

​
sku
string

Product SKU

Example:

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

​
id
string

A 24-character system-generated ID.

Example:

"5f7329dfd5288b0011332366"

​
itemId
integer

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

Example:

1682313863

​
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.

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