commerce/catalog/admin/attributedefinition/attributes

Attributes are used to add custom definitions and characteristics to the following objects:

  • Product attributes — are attributes that define the characteristics of products, enabling you to uniquely describe a product. They consist of options, properties, and extras. Refer to Product Attributes in the Guides section for more information.
  • Customer attributes — are custom attributes that you can apply to customer accounts to add further definition for special uses, such as marketing campaigns, or discounts. Refer to Customer Attributes in the Guides section for more information.
  • Order attributes — are custom attributes that enable you to uniquely describe an aspect of an order. Depending on the attribute definition, either you or a shopper can enter values for the order attribute. Refer to Order Attributes in the Guides section for more information.

JSON Example

Attribute Properties

Property Description
adminName

type: string

The administrator name associated with the object/data.

attributeCode

type: string

Merchant-defined code for an extensible attribute. This code may be used to generate an object's fully qualified name, such as for products.

attributeDataTypeSequence

type: int

Generated sequence that increments for each attribute and data type combination created. This value is system-supplied and read-only.

attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

attributeMetadata

type: list of attributeMetadataItem

List of metadata key-value pairs defined for an extensible attribute.

attributeMetadataItem.key

type: string

Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.

For search synonym definitions, refer to Synonym Expansion Types for more information about the key usage.

attributeMetadataItem.value

type: string

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

attributeSequence

type: int

Generated sequence that increments for each product attribute created. This value is system-supplied and read-only.

auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

content

type: attributeLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

attributeLocalizedContent.description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

attributeLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

attributeLocalizedContent.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

inputType

type: string

The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea.

isExtra

type: bool

If true, the product attribute is an add-on configuration made by the shopper that does not represent a product variation, such as a monogram.

isOption

type: bool

If true, the product attribute is a merchant- or shopper-configurable option, such as size or color, that represents a product variation.

isProperty

type: bool

If true, the product attribute describes aspects of the product that do not represent an option configurable by the shopper, such as screen resolution or brand.

localizedContent

type: list of attributeLocalizedContent

The localized content associated with the object.

attributeLocalizedContent.description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

attributeLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

attributeLocalizedContent.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

masterCatalogId

type: int

Unique identifier for the master catalog.

namespace

type: string

The namespace for the accessible APIs and source capabilities in the core of Kibo eCommerce APIs.

searchSettings

type: attributeSearchSettings

The settings to control product search and indexing behavior.

attributeSearchSettings.allowFilteringAndSortingInStorefront

type: bool

Indicates whether the attribute should be able to be used in filters, facets, and sorting on the public storefront.

attributeSearchSettings.customWeightInStorefrontSearch

type: bool

When set to true, enables you to set a custom search weight for a product attribute in search-settings.

attributeSearchSettings.indexValueWithCase

type: bool

Specifies whether to create a case-sensitive Solr search index. The default is false.

attributeSearchSettings.searchableInAdmin

type: bool

Indicates whether the attribute value is searchable in the merchant catalog admin.

attributeSearchSettings.searchableInStorefront

type: bool

Indicates if the attribute value is searchable on the public storefront.

attributeSearchSettings.searchDisplayValue

type: bool

Indicates what kind of values search queries and returns. If true, the system indexes the display value of string attributes instead of the canonical value for searching. Always use the canonical value for filtering. This does not apply for non-string attributes.

validation

type: attributeValidation

Properties used when validating a value entered for an object, including extensible attributes, products attributes, and database entries.

attributeValidation.maxDateValue

type: DateTime

The maximum date allowed including month, day, and year. System-supplied and read-only.

attributeValidation.maxNumericValue

type: decimal

The maximum number that can be entered as a value for an extensible attribute.

attributeValidation.maxStringLength

type: int

The maximum character length possible for a string value entered for an extensible attribute.

attributeValidation.minDateValue

type: DateTime

The minimum date allowed including month, day, and year. System-supplied and read-only.

attributeValidation.minNumericValue

type: decimal

The minimum numeric value required to validate an extensible attribute.

attributeValidation.minStringLength

type: int

The minimum character length possible for a string value entered for an extensible attribute.

attributeValidation.regularExpression

type: string

Regular expression used to process and validate an extensible attribute value that require special formatting, such as phone numbers.

valueType

type: string

An attribute value type is either predefined vocabulary set by the admin during attribute set up, or user-defined with an appropriate type (AdminEntered or ShopperEntered, depending on the user). These types are used by products and attributes. To use a predefined value, you can set this parameter as "predefined" and whatever the admin entered in the Product Attributes > Create New Attribute interface menu will become the predefined value on the attribute. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order.

vocabularyValues

type: list of attributeVocabularyValue

List of valid vocabulary values defined for an attribute.

attributeVocabularyValue.content

type: attributeVocabularyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

attributeVocabularyValue.displayOrder

type: int

The order in which the attribute value displays. If you omit a value for this property, Kibo eCommerce infers the display order from the attribute value's position the list.

attributeVocabularyValue.localizedContent

type: list of attributeVocabularyValueLocalizedContent

The localized content associated with the object.

attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

attributeVocabularyValue.productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

attributeVocabularyValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

attributeVocabularyValue.valueSequence

type: int

The number that denotes the order of the entity value within a list of entity values.

Operations

Operation Name Request URI Description
AddAttribute POST %3fresponseFields%3d%7bresponseFields%7d

Creates a new attribute to describe one aspect of a product such as color or size, based on its defined product type. The attribute name, attribute type, input type, and data type are required.

DeleteAttribute DELETE %7battributeFQN%7d

Deletes a defined product attribute. You cannot delete an attribute assigned a value for a product.

GetAttribute GET %7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified product attribute.

GetAttributes GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a paged list of attributes according to any specified filter criteria and sort options.

UpdateAttribute PUT %7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Updates an existing attribute with attribute properties to set.