Skip to main content
PUT
/
product-attributes
/
{id}
curl --request PUT \
  --url https://api.fabric.inc/v3/product-attributes/{id} \
  --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": "[email protected]"
}

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"

Path Parameters

​
id
string
required

The 24-character system-generated ID of the attribute to update.

Body

application/json

Request body to update attribute

​
name
string

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

Example:

"color"

​
description
string

Brief description of attribute

Example:

"Product color"

​
localizedProperties
object

Names of localized attributes

Example:
{
  "en-US": { "name": "color" },
  "en-IN": { "name": "colour" }
}
​
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"

​
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

Response

OK

​
id
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

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

​
updatedBy
string

Email of the user who last updated the attribute

Example:

"[email protected]"

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