fieldName

The fieldName represents the name of an attribute within your catalo, such as title, color, brand, etc. Ensure to follow the below thumbnail:

• Field names are case-sensitive.
• Field names must start with an alphabet or underscore.
• Field names can only contain alphanumeric characters, hyphens (-), and underscores (_).
• Field names cannot contain special characters or spaces.
• Field names cannot end with an underscore.

Mandatory

dataType

The dataType defines the type of value an attribute can have. The supported dataType values include:

• text: String – Used for text fields (e.g., title, color, brand, style). Searchable: Yes
• longText: String – Used for large text fields (e.g., description, summary). Searchable: Yes
• decimal: Decimal – Used for decimal values (e.g., price, discount). Searchable: No
• number: Numeric – Used for numeric values (e.g., quantity, orderCount, viewCount). Searchable: No
• link: URL – Used for URL values (e.g., productUrl, imageUrl). Searchable: No
• date: Date – Used for date values (e.g., createdAt, updatedAt). Searchable: No
• bool: Boolean – Used for boolean values (e.g., availability, hasBanner). Searchable: No
• sku: String – Used for product identifiers (e.g., sku, part number). Searchable: Yes
• path: String – Used for hierarchical fields (e.g., categoryPath). Searchable: No
• facet: String – Reserved for internal use by Unbxd for tokenization processing. Searchable: No
• nsku: String – Used for B2B catalogs supporting substring matches. Searchable: Yes
  Searchable=Yes means the field is part of the searchable index, Searchable= No means the field is part of the searchable index.

Mandatory

multiValued

The multiValued attribute specifies whether a field can accept multiple values for a product.

• multiValued = true if the field can accept multiple values. For example - a product that can have multiple colors or styles like "Casual" or "Sport"
• multiValued = false if the field can have only one value. For example product brand like "Nike"

Mandatory

autoSuggest

This specifies whether the attribute should have an auto-suggestion feature. This feature helps in providing suggestions as the user types, typically for text-based attributes (e.g., brand, title).

Mandatory

isVariant

The isVariant attribute indicates whether the field is a variant attribute, which is used only for catalogs with variants.

• isVariant = true for variant attributes (e.g., size, color).
• isVariant = false for parent product attributes (e.g., title, brand).

Optional

id

This attribute in the schema represents a numerical identifier for an attribute within the catalog. This is useful when product feeds contain field IDs instead of fieldNames.

Optional