Create attribute

Getting Started

Authentication v3

Concepts
System Apps
User Apps
Authentication Endpoints

Product Catalog

Product Catalog API - Overview
Developer Guide
Data Ingestion Best Practices
Attributes & Attribute Mapping
- Product Catalog - Attributes API
- Attributes
- Mapping
- Attribute Groups
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products

Orders

Orders (3.0.0)
Developer Guide
Orders FAQ
Shopping Lists
Shipping Methods
Imports
Exports
Orders
Frauds
Notifications
Backorders Preorders
Cancellations
Allocations
Shipments
Inventory Transfers
Tracking
Invoices
Payments
Credits
Appeasements
Returns

Inventory

Inventory (3.0.0)
Inventory FAQ
Imports
Counters
Inventory
Locations
Networks

Integrations

Offers

Offers (3.0.0)
Developer Guide
Real-time Pricing Engine
Price Lists
Prices
Price Types
Price Controls
Price Methods
Priced Products
Add-ons
Promotions
Coupons
Coupon Codes
Redemptions
Product Exclusion Lists
Segments
Imports
Exports
Attributes
Webhook Events

Carts

Overview
Developer Guides
Carts
Order Draft
Items
Addresses
Payments
Fulfillment
Customer
Coupons
Validations
Cart Orchestrator

Customers

Customer Profile
Customer Address
Customer Self

POST

product-attributes

object

name

string

description

string

type

enum<string>

target

Option 1 · enum<string>

localizedProperties

object

isLocalizable

boolean

validation

object

isMandatory

boolean

isManualOverwrite

boolean

formula

string

customValidationFormula

string

dateFormat

string

isDecimal

boolean

min

number

max

number

startWith

integer

increment

integer

subType

enum<string>

acceptedValues

array

localizedAcceptedValues

object

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

headerrequired

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

type

enum<string>

required

Attribute type

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

target

required

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

Available options:

PRODUCT,

CATEGORY

name

string

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

description

string

Attribute description

localizedProperties

object

Names of localized attributes

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.

validation

object

Validation details

validation.isMandatory

boolean

default: false

true: Attribute is mandatory. false: Attribute is optional

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.

validation.formula

string

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

validation.customValidationFormula

string

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

validation.dateFormat

string

Date format. Applicable when attributeType is DATETIME.

validation.isDecimal

boolean

default: false

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

validation.min

number

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

validation.max

number

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

validation.startWith

integer

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

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.

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

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.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.

Response

200 - application/json

string

Attribute ID

name

string

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

description

string

Brief description of attribute

type

enum<string>

Attribute type

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

target

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

Available options:

PRODUCT,

CATEGORY

localizedProperties

object

Names of localized attributes

isLocalizable

boolean

validation

object

Validation details

validation.isMandatory

boolean

default: false

true: Attribute is mandatory. false: Attribute is optional

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.

validation.formula

string

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

validation.customValidationFormula

string

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

validation.dateFormat

string

Date format. Applicable when attributeType is DATETIME.

validation.isDecimal

boolean

default: false

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

validation.min

number

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

validation.max

number

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

validation.startWith

integer

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

validation.increment

integer

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

validation.acceptedValues

string[]

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.

updatedBy

string

Email of the user who last updated the attribute

createdAt

string

Time of attribute creation (UTC)

updatedAt

string

Time of last update to attribute (UTC)

Was this page helpful?

Overview Update single attribute

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"
}