Create update and delete item attributes

Item attributes allow you to define specific characteristics for items. Common examples of attributes include size, color, and material. Well-defined attributes are important because they enable item discovery and make catalog management easier.
This endpoint creates and updates item attributes to be assigned later.
Note:
1) You can add and manage unlimited attributes for your items. Once they are created, they appear as a selectable option on product pages.
2) In addition, you can assign attributes to items on an individual level or in bulk.

Authorizations

Authorization

string

headerrequired

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

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json · object[]

action

enum<string>

Action to perform. id is required only for UPDATE, or DELETE (not for CREATE). <br /> Note: CREATE action replaces any existing item attribute with the same name, if one already exists.

Available options:

CREATE,

UPDATE,

DELETE

id

string

A 24-character system-generated attribute ID

name

string

Attribute name, which is visible on all relevant Product Catalog pages.

locales

object[]

Show child attributes

description

string

Attribute description

mapping

string

Attribute mapping of item. This corresponds to the Attribute Mapping settings of Product Catalog: sku, title, image, active, isVariant. <br /> Note: Most attributes do not have a mapping, in which case this will be null. <br /> Warning: Exercise caution while adding or removing mappings of attributes, as it could lead to bad data.

type

enum<string>

Attribute type

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

DATETIME,

OPTIONS

textSubType

enum<string>

Conditionally required sub-type for TEXT attribute type

Available options:

SMALL_TEXT,

TEXT_AREA,

HTML

serialStart

number

Conditionally required to indicate the starting value of SERIAL attribute type. When enabled, the subsequent attribute values increment by 1.

optionsType

enum<string>

Conditionally required to indicate the selectable values for the OPTIONS attribute type

Available options:

TEXT,

BOOLEAN,

DECIMAL,

INTEGER,

DATETIME

format

string

Attribute format. Currently used only for the attribute type DATETIME.

formula

string

JavaScript expression to dynamically compute the attribute's value. The type returned must match the attribute's type. If the attribute is weight, this formula helps calculate the weight. <br /> Note: When this is provided, validation is ignored.

validation

object

Show child attributes

Response

200 - application/json

attributes

object

Show child attributes