Update column attribute of product.

put

https://api-us.bluestonepim.com/pim/products/{id}/attributes/column/{definitionId}

Use this endpoint to update a column attribute of a product in Bluestone PIM. You can specify the updated attribute values, context, and whether to use a fallback for context.

For more details, refer to the Create, edit or remove attributes.

Path Params

string

required

The internal ID of the product for which the column attribute is being updated.

Example: 634c26e14cedfd0001775e9f

definitionId

string

required

Specify the attribute definition ID for the column attribute you want to update.

Query Params

forceVla

boolean

Defaults to false

Specifies whether to force the update of a variant level attribute (VLA) value down from a VARIANT GROUP product to all child VARIANT products.

This flag is only taken into consideration for VARIANT GROUP products and only where the attribute is currently set as a VLA on the VARIANT GROUP product.

If omitted, the default value false will be used which means that possible VLA values on a VARIANT GROUP product will not be enforced down to child VARIANT products.

Note that forceVla flag is only taken into consideration when the attribute change will be an update operation but not an add value (insert) operation on a VARIANT product.

This means that a child VARIANT product will get the new value if it does not have the attribute assigned or an attribute value defined even if forceVla is false while other child VARIANT products that already have an attribute value defined will be left unchanged.

This is because a VARIANT product without the attribute or without an attribute value defined is treated as an add value (insert) operation while the other VARIANT products are treated as update operations.

For more detailed information on working with VLAs in Bluestone PIM, refer to our help pages The data model - Variant Level Attribute (VLA).

Body Params

column

object

Column attribute values for the product.

A column attribute have a number of pre-defined columns and only one attribute value per column. One can think of it as a table with pre-defined columns but only one row.

Expected input format:

"column": {
  "<column ID>": "<column value>",
  "<column ID>": "<column value>",
  ...
}

Example:

Let us say that I have these columns pre-defined in the column attribute definition: "Column 1", with ID: 6356b491590801000124ef2d "Column 2", with ID: 6356b491590801000124ef2e "Column 3", with ID: 6356b491590801000124ef2f

I would like to store these values ("A", "B" and "C") in the columns:

	"Column 1"	"Column 2"	"Column 3"
Value (row 1):	"A"	"B"	"C"

Then that would correspond to this json structure:

"column": {
  "6356b491590801000124ef2d": "A",
  "6356b491590801000124ef2e": "B",
  "6356b491590801000124ef2f": "C"
}

Headers

context

string

Specifies the context in which to operate. If omitted, the default context en is used.

In Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: The default context is identified by the ID "en". IDs for additional contexts begin with a lowercase "L", not with the digit "1", followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.

context-fallback

string

Specifies whether to enable the fallback mechanism for the context. If omitted, the default value true will be used. When set to true, the system will provide a default translation or relevant information if the requested context's specific translation is missing.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: Setting the context-fallback parameter to false disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing.

Responses

204

No Content

400Bad Request This response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.