Create compound attribute definition.

post

https://api-us.bluestonepim.com/pim/compoundDefinitions

Create a new compound attribute definition. This operation allows users to define new attributes that are combinations of existing ones.

For more detailed information on managing compound attributes, refer to our help pages Attribute types - Compound.

Query Params

validation

string

enum

required

Validation strategy for the creation operation. Can be either NAME or NONE and defaults to NAME.

NAME means that a validation check will be performed to make sure that no other attribute definition exist with the same name.

NONE can be used to create an attribute definition with the same name as another existing attribute definition. Note: The number must always be unique.

Allowed:

Body Params

contextAware

boolean

description

string

externalSource

boolean

Specifies whether the origin of the attribute is managed in an external source like an ERP system or managed by a cloud function like an AWS Lambda or Azure Function and hence the attribute should be read-only for the editors in the Bluestone PIM web application UI.

Note: The value of the attribute can still be modified via the Management API, for example by an integration or a cloud function triggered by a webhook message from Bluestone PIM.

Note: A Compound attribute does not have an editable value since its value is generated dynamically on request, so in the case of Compound attributes, this flag only controls whether the editors in Bluestone PIM web application UI are able to add or remove the Compound attribute to/from a product.

format

array of strings

Specifies a set of strings that, together with the subattribute values, will be concatenated to form a compound value.

Example: Given I have a Compound attribute definition with only one subattribute added.

Subattribute value: "RED"

Format contains two strings, the string to use before the value from the subattribute the string to use after the value of the subattribute:

 "format": [
    "This is the value of my subattribute: '",
    "', and this is the end of the compound."
  ]

This would generate this dynamically generated compound attribute value when requested: This is the value of my subattribute: 'RED', and this is the end of the compound.

format

groupId

string

Specifies the group ID to which the attribute definition belongs.

Example: 634c26e14cedfd0001775e9f

internal

boolean

Indicates that the attribute is for internal use only within Bluestone PIM, meaning this value is not visible in the Public API (PAPI) for systems downstream of Bluestone PIM; for example, attributes for system configuration, enrichment workflows, or internal categorization.

name

string

Specifies the name of the attribute definition.

number

string

Specifies the number of the attribute definition.

subDefinitions

array of objects

length between 1 and 64

Specifies the ordered list of subattribute definitions in format: id, compound.

subDefinitions

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

201Created This response indicates that the request was successfully processed and the compound attribute definition has been updated.

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.

404Not Found This response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.

409Conflict This response indicates that the request could not be completed due to a conflict with the current state of the target resource. This typically occurs when there are duplicate entries or other data conflicts.