Create attribute

POST

product-attributes

curl --request POST \
  --url https://api.fabric.inc/v3/product-attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Category datetime example",
  "isLocalizable": false,
  "target": "CATEGORY",
  "type": "DATETIME",
  "validation": {
    "isMandatory": false,
    "isManualOverwrite": false,
    "formula": "",
    "dateFormat": "MM/DD/YYYY"
  }
}'

{
  "id": "64c15582e1f95e3214660d08",
  "name": "Category datetime example",
  "isLocalizable": false,
  "target": "CATEGORY",
  "type": "DATETIME",
  "validation": {
    "isMandatory": false,
    "isManualOverwrite": false,
    "formula": "",
    "dateFormat": "MM/DD/YYYY"
  },
  "updatedAt": "2023-07-26T17:18:47.162Z",
  "createdAt": "2023-07-26T17:18:47.162Z",
  "updatedBy": "test@email.com"
}

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.

Example:

"517fa9dfd42d8b00g1o3k312"

x-fabric-request-id

string

Unique request ID

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

Body

application/json

Request body to create attribute

type

enum<string>

required

Attribute type

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

Example:

"TEXT"

target

required

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

Available options:

PRODUCT,

CATEGORY

Example:

"PRODUCT"

name

string

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

Example:

"color"

description

string

Attribute description

Example:

"Product color"

localizedProperties

object

Names of localized attributes

Example:

{
  "en-US": { "name": "color" },
  "en-IN": { "name": "colour" }
}

isLocalizable

boolean

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

Example:

true

validation

object

Validation details

validation.isMandatory

boolean

default:false

true: Attribute is mandatory. false: Attribute is optional

Example:

true

validation.isManualOverwrite

boolean

default:false

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

Example:

true

validation.formula

string

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

Example:

"(async () => await attribute('id') *10)()"

validation.customValidationFormula

string

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

Example:

"(async () => await attribute('id') > 1)()"

validation.dateFormat

string

Date format. Applicable when attributeType is DATETIME.

Example:

"MM-DD-YYYY"

validation.isDecimal

boolean

default:false

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

Example:

true

validation.min

number

Minimum value allowed for an attribute. Applicable only when attributeType is NUMBER.

Example:

100

validation.max

number

Maximum value allowed for an attribute. Applicable only when attributeType is NUMBER.

Example:

100

validation.startWith

integer

Starting number in a series. Applicable only when attributeType is SERIAL.

Example:

1

validation.increment

integer

Represents number increment in a series. 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.

Example:

10

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

Example:

"SINGLE"

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.

Accepted values

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.

Example:

{
  "en-US": ["a", "b", "c"],
  "en-IN": ["x", "y", "z"]
}

Response

200

application/json

string

Attribute ID

Example:

"CAZZX1234567DDDDD"

name

string

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

Example:

"color"

description

string

Brief description of attribute

Example:

"Product color"

type

enum<string>

Attribute type

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

Example:

"TEXT"

target

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

Available options:

PRODUCT,

CATEGORY

Example:

"PRODUCT"

localizedProperties

object

Names of localized attributes

Example:

{
  "en-US": { "name": "color" },
  "en-IN": { "name": "colour" }
}

isLocalizable

boolean

Example:

true

validation

object

Validation details

validation.isMandatory

boolean

default:false

true: Attribute is mandatory. false: Attribute is optional

Example:

true

validation.isManualOverwrite

boolean

default:false

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

Example:

true

validation.formula

string

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

Example:

"(async () => await attribute('id') *10)()"

validation.customValidationFormula

string

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

Example:

"(async () => await attribute('id') > 1)()"

validation.dateFormat

string

Date format. Applicable when attributeType is DATETIME.

Example:

"MM-DD-YYYY"

validation.isDecimal

boolean

default:false

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

Example:

true

validation.min

number

Minimum value allowed for an attribute. Applicable only when attributeType is NUMBER.

Example:

100

validation.max

number

Maximum value allowed for an attribute. Applicable only when attributeType is NUMBER.

Example:

100

validation.startWith

integer

Starting number in a series. Applicable only when attributeType is SERIAL.

Example:

1

validation.increment

integer

Example:

10

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

Example:

"SINGLE"

validation.acceptedValues

string[]

Accepted values

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.

Example:

{
  "en-US": ["a", "b", "c"],
  "en-IN": ["x", "y", "z"]
}

updatedBy

string

Email of the user who last updated the attribute

Example:

"test@email.com"

createdAt

string

Time of attribute creation (UTC)

Example:

"2021-04-20T10:24:36.162Z"

updatedAt

string

Time of last update to attribute (UTC)

Example:

"2021-04-20T10:24:36.162Z"

Was this page helpful?

curl --request POST \
  --url https://api.fabric.inc/v3/product-attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Category datetime example",
  "isLocalizable": false,
  "target": "CATEGORY",
  "type": "DATETIME",
  "validation": {
    "isMandatory": false,
    "isManualOverwrite": false,
    "formula": "",
    "dateFormat": "MM/DD/YYYY"
  }
}'

{
  "id": "64c15582e1f95e3214660d08",
  "name": "Category datetime example",
  "isLocalizable": false,
  "target": "CATEGORY",
  "type": "DATETIME",
  "validation": {
    "isMandatory": false,
    "isManualOverwrite": false,
    "formula": "",
    "dateFormat": "MM/DD/YYYY"
  },
  "updatedAt": "2023-07-26T17:18:47.162Z",
  "createdAt": "2023-07-26T17:18:47.162Z",
  "updatedBy": "test@email.com"
}

Release Notes

Authorizations

Headers

Body

Response