Skip to main content

Enumeration: AttributeFieldName

Defined in: enum/AttributeFieldName.ts:5

AttributeFieldName Enum for attribute field names used in Propeller eCommerce Platform

Enumeration Members​

ATTRIBUTE_CLASS​

ATTRIBUTE_CLASS: "ATTRIBUTE_CLASS"

Defined in: enum/AttributeFieldName.ts:25

[Optional][Enum] The class the Attribute or AttributeDescription belongs to, must be one of the following: [products, clusters, categories, customers, contacts, companies]

ATTRIBUTE_DESCRIPTION_ID​

ATTRIBUTE_DESCRIPTION_ID: "ATTRIBUTE_DESCRIPTION_ID"

Defined in: enum/AttributeFieldName.ts:7

[Required][String] The ID of the AttributeDescription, required if attributeDescriptionName is not provided

ATTRIBUTE_DESCRIPTION_NAME​

ATTRIBUTE_DESCRIPTION_NAME: "ATTRIBUTE_DESCRIPTION_NAME"

Defined in: enum/AttributeFieldName.ts:9

[Required][String] The Name of the AttributeDescription, required if attributeDescriptionId is not provided

COLOR_VALUE​

COLOR_VALUE: "COLOR_VALUE"

Defined in: enum/AttributeFieldName.ts:23

[Optional][String] Attribute color value, required for COLOR type attributes

DATE_TIME_VALUE​

DATE_TIME_VALUE: "DATE_TIME_VALUE"

Defined in: enum/AttributeFieldName.ts:21

[Optional][DateTime] Attribute datetime value, required for DATETIME type attributes in ISO 8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' (e.g., 2024-10-31T09:55:00.000Z)

DECIMAL_VALUE​

DECIMAL_VALUE: "DECIMAL_VALUE"

Defined in: enum/AttributeFieldName.ts:19

[Optional][Decimal] Attribute decimal value, required for DECIMAL type attributes

ENUM_VALUES​

ENUM_VALUES: "ENUM_VALUES"

Defined in: enum/AttributeFieldName.ts:15

[Optional][Array] Attribute enum values, required for ENUM type attributes

INT_VALUE​

INT_VALUE: "INT_VALUE"

Defined in: enum/AttributeFieldName.ts:17

[Optional][Integer] Attribute integer value, required for INTEGER type attributes

LOOKUP_KEY​

LOOKUP_KEY: "LOOKUP_KEY"

Defined in: enum/AttributeFieldName.ts:27

The lookupKey to find the resource by, i.e. id or sourceId

LOOKUP_VALUE​

LOOKUP_VALUE: "LOOKUP_VALUE"

Defined in: enum/AttributeFieldName.ts:29

The lookupValue to find the resource by, i.e. the id or the sourceId

SOURCE​

SOURCE: "SOURCE"

Defined in: enum/AttributeFieldName.ts:31

The source of the lookupValue when the lookupKey is a sourceId

TEXT_VALUES​

TEXT_VALUES: "TEXT_VALUES"

Defined in: enum/AttributeFieldName.ts:11

[Optional][String] Attribute value descriptions per language, required for TEXT type attributes

TEXT_VALUES_LANGUAGE​

TEXT_VALUES_LANGUAGE: "TEXT_VALUES_LANGUAGE"

Defined in: enum/AttributeFieldName.ts:13

[Optional][String] Attribute value descriptions per language, required for TEXT type attributes