Backend API

Fields
idstringrequiredauto

Unique identifier for the attribute. Defaults to attribute name underscored.

namestringrequired

A human-friendly name for the attribute.

date_createddateauto

Date and time the attribute was created.

date_updateddateauto

Date and time the attribute was last updated.

collectionstring

Collection to look up when the attribute type is lookup. Required when type is lookup.

defaultmixed

Default value used when entering a value for the attribute.

filterableboolean

Indicates if the category is available in the storefront category page filters.

localizedboolean

Indicates if this attribute supports localized content.

manualboolean

Indicates the variant attribute values are edited manually.

multiboolean

When attribute type=image is indicated, the attribute contains multiple images.

name_patternstring

Pattern for resolving the display label from a target collection record (e.g. {name}). Defaults to the target model's name field.

productsProduct

Expandable list of products using the attribute.

requiredboolean

Indicates the attribute requires a value when assigned to a product.

searchableboolean

Indicates if this attribute is searchable on the backend.

typeenum

Input type used when entering a value for the attribute.

Possible enum values:

short_textlong_textassetlookupbooleanselectnumberdatetagsiconcollectionfield_groupfield_rowtexttextareadropdowncheckboxradioimagefilecurrency
valuesarray of child_scalar

List of the attribute's associated select options used with attribute type of checkbox, radio, or select.

variantboolean

Indicates if this attribute is a variant.

visibleboolean

Indicates the attribute is visible to customers.

Response
{
  "id": "material",
  "name": "Color",
  "date_created": "2021-07-16T14:35:59.968Z",
  "date_updated": "2021-07-16T14:35:59.968Z",
  "default": null,
  "required": false,
  "type": "text",
  "values": [
    "Red",
    "White",
    "Blue",
    "Green",
    "Yellow",
    "Black"
  ],
  "visible": true
}