Partially 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. With this endpoint, you can partially update attributes of a given product. Note:
1. This endpoint is recommended over PUT /products/{id}/attributes (Update product attributes by ID) if you want to update only specific attributes without affecting the others.
2. If you don’t have product ID, use the corresponding SKU-based endpoint - PATCH /products/sku/{sku}/attributes.

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.

x-fabric-request-id

string

Unique request ID

Path Parameters

id

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, <br />1. When the status is DRAFT, this operations will only apply to the Draft version of product, if it exists <br />2. When the status is LIVE, this operation will only apply to the Live version of the product, if it exists <br />3 When the status is LIVE,DRAFT, this operation will prioritize Live version first, if it exists. Otherwise, the Draft version is considered. <br />4 When the status is DRAFT,LIVE this operation will prioritize the Draft version first, if it exists. Otherwise, the Live version is considered.

Body

application/json

Request for partial update

data

object[]

required

Show child attributes

data.op

enum<string>

required

Patch operations

Available options:

add,

replace,

remove

data.path

string

required

Attribute path

data.value

Attribute value

Response

200 - application/json

Details of Item by ID

attributes

object[]

Attributes of product

Show child attributes

attributes.id

string

Product ID

attributes.isDeleted

boolean | null

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

attributes.isInherited

boolean | null

true: Attributes are inherited from parent product <br /> false: Attributes aren't inherited from parent product

attributes.name

string

Attribute name

attributes.type

string

Attribute type

attributes.validation

object

Attribute validation - date

Show child attributes

attributes.validation.dateFormat

string

Date format. <br> Applicable when attributeType is DATETIME.

attributes.value

Attribute value

bundleProducts

object[]

Items or variants that are part of Bundle by ID

Show child attributes

bundleProducts.id

string

required

Product ID

bundleProducts.quantity

integer

required

Number of items or variants in bundle

categoryId

string

24-character system-generated category ID of product

createdAt

string

Time of product creation (UTC)

hasDraft

boolean

true: Product has a Draft version <br /> false: Product doesn't have a Draft version

hasLive

boolean

true: Product has a Live version <br /> false: Product doesn't have a Live version

id

string

Product ID

isActive

boolean

true: Product is active <br /> false: Product is inactive

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

localizedProperties.{key}.attributes.isDeleted

boolean | null

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

localizedProperties.{key}.attributes.isInherited

boolean | null

true: Attributes are inherited from parent product <br /> false: Attributes aren't inherited from parent product

localizedProperties.{key}.attributes.name

string

Attribute name

localizedProperties.{key}.attributes.type

string

Attribute type

localizedProperties.{key}.attributes.validation

object

Attribute validation - date

Show child attributes

localizedProperties.{key}.attributes.validation.dateFormat

string

Date format. <br> Applicable when attributeType is DATETIME.

localizedProperties.{key}.attributes.value

Attribute value

parentProduct

object

Parent item ID of the Variant

Show child attributes

parentProduct.id

string

Product ID

sku

string

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

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

type

enum<string>

Supported product types

Available options:

ITEM,

VARIANT,

BUNDLE

updatedAt

string

Time of last update to product (UTC)

variants

object[]

Product variants by ID

Show child attributes

variants.id

string

required

Product ID