Update a product by SKU
Use this endpoint to update details of a product by its SKU. You can update details of the product, such as the product name, category details, product images, attributes, and collections. The new data replaces the existing data. Note that you can’t update the SKU.
If you don’t have the product SKU, use one of the endpoints update the product details:
Authorizations
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
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.
Unique request ID
Path Parameters
The Stock Keeping Unit (SKU) of a product provided by the merchant.
Query Parameters
The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format).
The default value is en-US.
Body
A sample request to update a product.
The name of the product.
"Nike Men's Training Shoe"
The list of product images.
[
"https://myawsomestore.com/is/image/nike/8801290_s7"
]
The name of the attribute and its value.
The details of the attribute.
The time of product creation, in UTC format.
"2021-12-13T13:56:09.006Z"
The time of last update to product, in UTC format.
"2021-12-13T13:56:09.006Z"
The name of the category. This value is overridden if the categories are populated.
"Sport Shoes"
A 24-character system-generated ID of the category.
"648014741adc8a9de14e1a68"
The category details, including their paths from the leaf category to the root category.
The details of a category.
[
{
"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" }]
}
]
The details of the collection.
[
{
"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
}
]
}
]
Represents the item
product type.
ITEM
"ITEM"
The details of the item variants.
A common schema for product, variants, and bundles along with their identifiers.
A sample request to update a product.
The name of the product.
"Nike Men's Training Shoe"
The list of product images.
[
"https://myawsomestore.com/is/image/nike/8801290_s7"
]
The name of the attribute and its value.
The details of the attribute.
The time of product creation, in UTC format.
"2021-12-13T13:56:09.006Z"
The time of last update to product, in UTC format.
"2021-12-13T13:56:09.006Z"
The name of the category. This value is overridden if the categories are populated.
"Sport Shoes"
A 24-character system-generated ID of the category.
"648014741adc8a9de14e1a68"
The category details, including their paths from the leaf category to the root category.
The details of a category.
[
{
"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" }]
}
]
The details of the collection.
[
{
"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
}
]
}
]
Represents the item
product type.
ITEM
"ITEM"
The details of the item variants.
A common schema for product, variants, and bundles along with their identifiers.
A sample request to update a product.
The name of the product.
"Nike Men's Training Shoe"
The list of product images.
[
"https://myawsomestore.com/is/image/nike/8801290_s7"
]
The name of the attribute and its value.
The details of the attribute.
The time of product creation, in UTC format.
"2021-12-13T13:56:09.006Z"
The time of last update to product, in UTC format.
"2021-12-13T13:56:09.006Z"
The name of the category. This value is overridden if the categories are populated.
"Sport Shoes"
A 24-character system-generated ID of the category.
"648014741adc8a9de14e1a68"
The category details, including their paths from the leaf category to the root category.
The details of a category.
[
{
"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" }]
}
]
The details of the collection.
[
{
"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
}
]
}
]
Represents the variant
product type.
VARIANT
"VARIANT"
Product SKU
"24ggs67-e89b-12e3-a456-026614174119"
A sample request to update a product.
The name of the product.
"Nike Men's Training Shoe"
The list of product images.
[
"https://myawsomestore.com/is/image/nike/8801290_s7"
]
The name of the attribute and its value.
The details of the attribute.
The time of product creation, in UTC format.
"2021-12-13T13:56:09.006Z"
The time of last update to product, in UTC format.
"2021-12-13T13:56:09.006Z"
The name of the category. This value is overridden if the categories are populated.
"Sport Shoes"
A 24-character system-generated ID of the category.
"648014741adc8a9de14e1a68"
The category details, including their paths from the leaf category to the root category.
The details of a category.
[
{
"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" }]
}
]
The details of the collection.
[
{
"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
}
]
}
]
Represents the bundle
product type.
BUNDLE
"BUNDLE"
The details of a bundle.
The details of the bundle.
Response
The details of a product based on the product type.
The name of the product.
"Nike Men's Training Shoe"
The list of product images.
[
"https://myawsomestore.com/is/image/nike/8801290_s7"
]
The name of the attribute and its value.
The details of the attribute.
The time of product creation, in UTC format.
"2021-12-13T13:56:09.006Z"
The time of last update to product, in UTC format.
"2021-12-13T13:56:09.006Z"
Product SKU
"24ggs67-e89b-12e3-a456-026614174119"
A 24-character system-generated ID.
"5f7329dfd5288b0011332366"
A unique identifier of an item, a variant or a bundle.
1682313863
The name of the category.
"Shoes"
A 24-character system-generated category ID.
"648055dff4aa98d6c43e02da"
The list of categories, including their paths from the leaf category to the root category.
The details of a category.
The details of the collection used to display products on the storefront.
The collection details.
Represents the item
product type.
ITEM
"ITEM"
The details of item variants.
A common schema for product, variants, and bundles along with their identifiers.
The details of a product based on the product type.
The name of the product.
"Nike Men's Training Shoe"
The list of product images.
[
"https://myawsomestore.com/is/image/nike/8801290_s7"
]
The name of the attribute and its value.
The details of the attribute.
The time of product creation, in UTC format.
"2021-12-13T13:56:09.006Z"
The time of last update to product, in UTC format.
"2021-12-13T13:56:09.006Z"
Product SKU
"24ggs67-e89b-12e3-a456-026614174119"
A 24-character system-generated ID.
"5f7329dfd5288b0011332366"
A unique identifier of an item, a variant or a bundle.
1682313863
The name of the category.
"Shoes"
A 24-character system-generated category ID.
"648055dff4aa98d6c43e02da"
The list of categories, including their paths from the leaf category to the root category.
The details of a category.
The details of the collection used to display products on the storefront.
The collection details.
Represents the item
product type.
ITEM
"ITEM"
The details of item variants.
A common schema for product, variants, and bundles along with their identifiers.
The details of a product based on the product type.
The name of the product.
"Nike Men's Training Shoe"
The list of product images.
[
"https://myawsomestore.com/is/image/nike/8801290_s7"
]
The name of the attribute and its value.
The details of the attribute.
The time of product creation, in UTC format.
"2021-12-13T13:56:09.006Z"
The time of last update to product, in UTC format.
"2021-12-13T13:56:09.006Z"
Product SKU
"24ggs67-e89b-12e3-a456-026614174119"
A 24-character system-generated ID.
"5f7329dfd5288b0011332366"
A unique identifier of an item, a variant or a bundle.
1682313863
The name of the category.
"Shoes"
A 24-character system-generated category ID.
"648055dff4aa98d6c43e02da"
The list of categories, including their paths from the leaf category to the root category.
The details of a category.
The details of the collection used to display products on the storefront.
The collection details.
Represents the variant
product type.
VARIANT
"VARIANT"
Product SKU
"24ggs67-e89b-12e3-a456-026614174119"
A 24-character system-generated ID of the parent item.
"648014741adc8a9de14e1a68"
The details of a product based on the product type.
The name of the product.
"Nike Men's Training Shoe"
The list of product images.
[
"https://myawsomestore.com/is/image/nike/8801290_s7"
]
The name of the attribute and its value.
The details of the attribute.
The time of product creation, in UTC format.
"2021-12-13T13:56:09.006Z"
The time of last update to product, in UTC format.
"2021-12-13T13:56:09.006Z"
Product SKU
"24ggs67-e89b-12e3-a456-026614174119"
A 24-character system-generated ID.
"5f7329dfd5288b0011332366"
A unique identifier of an item, a variant or a bundle.
1682313863
The name of the category.
"Shoes"
A 24-character system-generated category ID.
"648055dff4aa98d6c43e02da"
The list of categories, including their paths from the leaf category to the root category.
The details of a category.
The details of the collection used to display products on the storefront.
The collection details.
Represents the bundle
product type.
BUNDLE
"BUNDLE"
The details of a bundle.
The details of the bundle.
Was this page helpful?