Create attribute

In fabric Product Catalog, both products (Items, Variants, and Bundles) and categories have attributes. For products, they may be technical specifications like size, weight, etc., design specifications like color, material, etc. For Categories, they may be basic specifications such as name, description, ID, etc. This endpoint creates attributes that can be assigned to a target - Product or Category.

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

Body

application/json

target

required

Single string for EQUALS operation; comma-separated string for an IN operation

Available options:

PRODUCT,

CATEGORY

type

enum<string>

required

Attribute type

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

description

string

Attribute description

isLocalizable

boolean

true: Attribute name is translated into different languages or localized for different regions <br /> false: Attribute name isn't localized Note: Refer to localizedProperties to get relevant attributes based on locale.

localizedProperties

object

Names of localized attributes

Show child attributes

localizedProperties.{key}

object

Show child attributes

localizedProperties.{key}.name

string

Localized name

name

string

Attribute name that appears when it isn't localized. Refer to localizedProperties to get the localized name.

validation

object

Validation details

Show child attributes

validation.acceptedValues

string[]

List of accepted values. Applicable when the attributeType is OPTIONS and subType is MULTIPLE. Note: When non-localized, shows the attribute name as it is. Otherwise, shows the localized name.

validation.customValidationFormula

string

JavaScript can be provided here to add custom validations.<br /> Applicable only for attributeType - TEXT, NUMBER, OPTIONS, and DATE.

validation.dateFormat

string

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

validation.formula

string

JavaScript will be evaluated and applied on product. <br /> Applicable only for attributeType - TEXT, NUMBER, OPTIONS, and DATE.

validation.increment

integer

Represents number increment in a series. <br /> Applicable only when attributeType is SERIAL. For example, if the startWith is 5 and increment is 5, the next value in the series will 10, 15, and so forth.

validation.isDecimal

boolean

default:

false

true: Input can be a float. <br /> false: Input must be an integer. <br /> Applicable only when attributeType is NUMBER.

validation.isMandatory

boolean

default:

false

true: Attribute is mandatory. <br /> false: Attribute is optional

validation.isManualOverwrite

boolean

default:

false

true: The value isn't computed using formula property <br /> false: The value is computed using formula property. <br /> Note: manualOverwrite is applicable only for formula property.

validation.localizedAcceptedValues

object

List of accepted localized values. Applicable when the attributeType is OPTIONS and subType is MULTIPLE. When attribute name is localized, the localized values are shown.

Show child attributes

validation.localizedAcceptedValues.{key}

string[]

validation.max

number

Maximum value allowed for an attribute. <br /> Applicable only when attributeType is NUMBER.

validation.min

number

Minimum value allowed for an attribute. <br /> Applicable only when attributeType is NUMBER.

validation.startWith

integer

Starting number in a series. <br /> Applicable only when attributeType is SERIAL.

validation.subType

enum<string>

Subtypes such as SINGLE and MULTIPLE are applicable when attributeType is OPTIONS. The rest of the subTypes are applicable when attributeType is TEXT.

Available options:

SINGLE,

MULTIPLE,

SMALL_TEXT,

TEXT_AREA,

HTML

Response

200 - application/json

createdAt

string

Time of attribute creation (UTC)

description

string

Brief description of attribute

id

string

Attribute ID

isLocalizable

boolean

true: Attribute name is translated into different languages or localized for different regions <br /> false: Attribute name isn't localized Note: Refer to localizedProperties to get relevant attributes based on locale.

localizedProperties

object

Names of localized attributes

Show child attributes

localizedProperties.{key}

object

Show child attributes

localizedProperties.{key}.name

string

Localized name

name

string

Non-localized attribute name. Refer to localizedProperties to get the localized name.

target

Single string for EQUALS operation; comma-separated string for an IN operation

Available options:

PRODUCT,

CATEGORY

type

enum<string>

Attribute type

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

updatedAt

string

Time of last update to attribute (UTC)

updatedBy

string

Email of the user who last updated the attribute

validation

object

Validation details

Show child attributes

validation.acceptedValues

string[]

List of accepted values. Applicable when the attributeType is OPTIONS and subType is MULTIPLE. Note: When non-localized, shows the attribute name as it is. Otherwise, shows the localized name.

validation.customValidationFormula

string

JavaScript can be provided here to add custom validations.<br /> Applicable only for attributeType - TEXT, NUMBER, OPTIONS, and DATE.

validation.dateFormat

string

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

validation.formula

string

JavaScript will be evaluated and applied on product. <br /> Applicable only for attributeType - TEXT, NUMBER, OPTIONS, and DATE.

validation.increment

integer

Represents number increment in a series. <br /> Applicable only when attributeType is SERIAL. For example, if the startWith is 5 and increment is 5, the next value in the series will 10, 15, and so forth.

validation.isDecimal

boolean

default:

false

true: Input can be a float. <br /> false: Input must be an integer. <br /> Applicable only when attributeType is NUMBER.

validation.isMandatory

boolean

default:

false

true: Attribute is mandatory. <br /> false: Attribute is optional

validation.isManualOverwrite

boolean

default:

false

true: The value isn't computed using formula property <br /> false: The value is computed using formula property. <br /> Note: manualOverwrite is applicable only for formula property.

validation.localizedAcceptedValues

object

List of accepted localized values. Applicable when the attributeType is OPTIONS and subType is MULTIPLE. When attribute name is localized, the localized values are shown.

Show child attributes

validation.localizedAcceptedValues.{key}

string[]

validation.max

number

Maximum value allowed for an attribute. <br /> Applicable only when attributeType is NUMBER.

validation.min

number

Minimum value allowed for an attribute. <br /> Applicable only when attributeType is NUMBER.

validation.startWith

integer

Starting number in a series. <br /> Applicable only when attributeType is SERIAL.

validation.subType

enum<string>

Subtypes such as SINGLE and MULTIPLE are applicable when attributeType is OPTIONS. The rest of the subTypes are applicable when attributeType is TEXT.

Available options:

SINGLE,

MULTIPLE,

SMALL_TEXT,

TEXT_AREA,

HTML