Update Product Attributes by ID

curl --request PUT \
  --url https://api.fabric.inc/v3/products/{id}/attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": [
    {
      "id": "6d7329dfd5288b0011332311",
      "value": "blue"
    }
  ],
  "localizedProperties": {
    "en-US": {
      "attributes": [
        {
          "id": "W123333RRTT555y1",
          "value": "blue"
        }
      ]
    },
    "en-IN": {
      "attributes": [
        {
          "id": "W123333RRTT555AA",
          "value": "blue"
        }
      ]
    }
  }
}
'

{
  "id": "5g7329dfd5288b00113323p7",
  "sku": "QWERTTY56DDFFVVV",
  "type": "ITEM",
  "isActive": true,
  "hasDraft": true,
  "hasLive": true,
  "status": "LIVE",
  "attributes": [
    {
      "id": "227329dfd5288b0011332315",
      "name": "Color",
      "type": "string",
      "isDeleted": false,
      "value": "blue",
      "isInherited": true
    }
  ],
  "localizedProperties": {
    "en-US": {
      "attributes": [
        {
          "id": "637329dfd5288b0011332354",
          "name": "Color",
          "type": "string",
          "isDeleted": false,
          "value": "blue",
          "isInherited": true
        }
      ]
    },
    "en-IN": {
      "attributes": [
        {
          "id": "8f7329dfd5288b0011332334",
          "name": "Colour",
          "type": "string",
          "isDeleted": false,
          "value": "blue",
          "isInherited": true
        }
      ]
    }
  },
  "variants": [
    {
      "id": "967329dfd5288b0011332356"
    }
  ],
  "categoryId": "7f7329dfd5288b0011332378",
  "createdAt": "2021-09-14T22:10:30.618Z",
  "updatedAt": "2021-09-14T22:10:30.618Z"
}

Update Product Attributes

Update Product Attributes by ID

Product attributes are the objective and factual descriptions of products that shoppers see when they browse through an e-commerce platform. Attributes may be technical specifications like size, weight, etc., design specifications like color, material, etc., or basic specifications such as name, description, ID, etc. This endpoint is used to update product attributes, completely replacing the existing ones. Note:
1. This endpoint is recommended over PATCH /products/{id}/attributes, if the update involves replacing all the attributes. If there are any missing or null fields in the request, the original values will be replaced with empty ones.
2. If you don’t have product ID, use the corresponding SKU-based endpoint - PUT /products/sku/{sku}/attributes.

PUT

products

{id}

attributes

Update Product Attributes by ID

curl --request PUT \
  --url https://api.fabric.inc/v3/products/{id}/attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": [
    {
      "id": "6d7329dfd5288b0011332311",
      "value": "blue"
    }
  ],
  "localizedProperties": {
    "en-US": {
      "attributes": [
        {
          "id": "W123333RRTT555y1",
          "value": "blue"
        }
      ]
    },
    "en-IN": {
      "attributes": [
        {
          "id": "W123333RRTT555AA",
          "value": "blue"
        }
      ]
    }
  }
}
'

{
  "id": "5g7329dfd5288b00113323p7",
  "sku": "QWERTTY56DDFFVVV",
  "type": "ITEM",
  "isActive": true,
  "hasDraft": true,
  "hasLive": true,
  "status": "LIVE",
  "attributes": [
    {
      "id": "227329dfd5288b0011332315",
      "name": "Color",
      "type": "string",
      "isDeleted": false,
      "value": "blue",
      "isInherited": true
    }
  ],
  "localizedProperties": {
    "en-US": {
      "attributes": [
        {
          "id": "637329dfd5288b0011332354",
          "name": "Color",
          "type": "string",
          "isDeleted": false,
          "value": "blue",
          "isInherited": true
        }
      ]
    },
    "en-IN": {
      "attributes": [
        {
          "id": "8f7329dfd5288b0011332334",
          "name": "Colour",
          "type": "string",
          "isDeleted": false,
          "value": "blue",
          "isInherited": true
        }
      ]
    }
  },
  "variants": [
    {
      "id": "967329dfd5288b0011332356"
    }
  ],
  "categoryId": "7f7329dfd5288b0011332378",
  "createdAt": "2021-09-14T22:10:30.618Z",
  "updatedAt": "2021-09-14T22:10:30.618Z"
}

Authorizations

Authorization

string

header

required

S2S access token (JWT) from fabric Identity service (during Login)

Headers

x-fabric-tenant-id

string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Example:

"517fa9dfd42d8b00g1o3k312"

x-fabric-request-id

string

Unique request ID

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

Path Parameters

string

required

24-character system-generated product ID

Query Parameters

statuses

string

default:DRAFT,LIVE

Comma-separated statuses indicating the preferred order of the product versions considered for this operation (endpoint action). For example,
1. When the status is DRAFT, this operations will only apply to the Draft version of product, if it exists
2. When the status is LIVE, this operation will only apply to the Live version of the product, if it exists
3 When the status is LIVE,DRAFT, this operation will prioritize Live version first, if it exists. Otherwise, the Draft version is considered.
4 When the status is DRAFT,LIVE this operation will prioritize the Draft version first, if it exists. Otherwise, the Live version is considered.

Example:

"DRAFT"

Body

application/json

Request to update product attributes.

attributes

object[]

Array of product attributes

Show child attributes

attributes.id

string

required

24-character system-generated attribute ID

Example:

"6d7329dfd5288b0011332311"

attributes.value

required

Attribute value

Example:

"blue"

localizedProperties

object

Show child attributes

localizedProperties.{key}

object

Localized names of attributes

Show child attributes

localizedProperties.{key}.attributes

object[]

Array of product attributes

Show child attributes

localizedProperties.{key}.attributes.id

string

required

24-character system-generated attribute ID

Example:

"6d7329dfd5288b0011332311"

localizedProperties.{key}.attributes.value

required

Attribute value

Example:

"blue"

Example:

{
  "en-US": {
    "attributes": [
      { "id": "W123333RRTT555y1", "value": "blue" }
    ]
  },
  "en-IN": {
    "attributes": [
      { "id": "W123333RRTT555AA", "value": "blue" }
    ]
  }
}

Response

Details of Item by ID

string

Product ID

Example:

"AASSBCC12334FCD12334V"

sku

string

Unique product ID that maps to fabric's standard attribute called SKU.
Note: sku shouldn't include ; or =

Example:

"XP-123345"

type

enum<string>

Supported product types

Available options:

ITEM,

VARIANT,

BUNDLE

Example:

"ITEM"

isActive

boolean

true: Product is active
false: Product is inactive

Example:

true

hasDraft

boolean

true: Product has a Draft version
false: Product doesn't have a Draft version

Example:

true

hasLive

boolean

true: Product has a Live version
false: Product doesn't have a Live version

Example:

true

status

enum<string>

Represents the current status of product. This value takes precedence over isActive if both are sent in the request.

Available options:

DRAFT,

LIVE

Example:

"LIVE"

attributes

object[]

Attributes of product

Show child attributes

attributes.id

string

Product ID

Example:

"AASSBCC12334FCD12334V"

attributes.name

string

Attribute name

Example:

"color"

attributes.type

string

Attribute type

Example:

"string"

attributes.validation

object

Attribute validation - date

Show child attributes

attributes.validation.dateFormat

string

Date format.
Applicable when attributeType is DATETIME.

Example:

"MM-DD-YYYY"

attributes.isDeleted

boolean | null

true: Attributes are inherited from parent product
false: Attributes aren't inherited from parent product Note: Attributes are soft deleted when a product is moved from one category to another.

Example:

false

attributes.isInherited

boolean | null

true: Attributes are inherited from parent product
false: Attributes aren't inherited from parent product

Example:

true

attributes.value

Attribute value

Example:

"blue"

localizedProperties

object

Localized attribute names

Show child attributes

localizedProperties.{key}

object

Show child attributes

localizedProperties.{key}.attributes

object[]

Show child attributes

localizedProperties.{key}.attributes.id

string

Product ID

Example:

"AASSBCC12334FCD12334V"

localizedProperties.{key}.attributes.name

string

Attribute name

Example:

"color"

localizedProperties.{key}.attributes.type

string

Attribute type

Example:

"string"

localizedProperties.{key}.attributes.validation

object

Attribute validation - date

Show child attributes

localizedProperties.{key}.attributes.validation.dateFormat

string

Date format.
Applicable when attributeType is DATETIME.

Example:

"MM-DD-YYYY"

localizedProperties.{key}.attributes.isDeleted

boolean | null

true: Attributes are inherited from parent product
false: Attributes aren't inherited from parent product Note: Attributes are soft deleted when a product is moved from one category to another.

Example:

false

localizedProperties.{key}.attributes.isInherited

boolean | null

true: Attributes are inherited from parent product
false: Attributes aren't inherited from parent product

Example:

true

localizedProperties.{key}.attributes.value

Attribute value

Example:

"blue"

Example:

{
  "en-US": {
    "attributes": [
      {
        "id": "4e7329dfd5288b0011332366",
        "name": "Color",
        "type": "string",
        "isDeleted": false,
        "value": "blue",
        "isInherited": true
      }
    ]
  }
}

parentProduct

object

Parent item ID of the Variant

Show child attributes

parentProduct.id

string

Product ID

Example:

"AASSBCC12334FCD12334V"

variants

object[]

Product variants by ID

Show child attributes

variants.id

string

required

Product ID

Example:

"AASSBCC12334FCD12334V"

categoryId

string

24-character system-generated category ID of product

Example:

"6h7329dfd5288b001133231d"

bundleProducts

object[]

Items or variants that are part of Bundle by ID

Show child attributes

bundleProducts.id

string

required

Product ID

Example:

"AASSBCC12334FCD12334V"

bundleProducts.quantity

integer<int32>

required

Number of items or variants in bundle

Example:

2

createdAt

string

Time of product creation (UTC)

Example:

"2021-09-14T22:10:30.618Z"

updatedAt

string

Time of last update to product (UTC)

Example:

"2021-09-14T22:10:30.618Z"

Get Product List Update Product Attributes by SKU

⌘I

Product Catalog

Product Catalog User Guides

Product Catalog API

Developer Guide

Catalog Connector User Guides

Catalog Connector API

Update Product Attributes by ID

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response