CatalogCustomAttribute

A merchant-defined property describing a characteristic of a retail catalog product, represented as a name and one or more values. For example, Material: Cotton or Vintage: 2015. These let merchants capture details specific to their catalog that are not covered by the standard product fields.

For single-valued types (TEXT, INTEGER, DOUBLE, BOOLEAN, SELECT) the list contains exactly one element, which should be parsed according to type. For MULTI_SELECT the list may contain zero or more values.

id
string <uuid>

The unique identifier of the custom attribute definition.

name
string

The name of the custom attribute, for example, "Material".

type
string

The type of the custom attribute. Possible values include:

  • TEXT: A free-form text attribute with a single string value.
  • INTEGER: An integer attribute; its single value is the string representation of the integer.
  • DOUBLE: A double attribute; its single value is the string representation of the double.
  • BOOLEAN: A boolean attribute; its single value is the string representation of the boolean.
  • SELECT: A single-select attribute with one chosen string value.
  • MULTI_SELECT: A multi-select attribute with zero or more chosen string values.
  • UNSPECIFIED: Attribute type is not specified or unknown.
Enum: "TEXT" "INTEGER" "DOUBLE" "BOOLEAN" "SELECT" "MULTI_SELECT" "UNSPECIFIED"
Array of objects (CatalogCustomAttributeValue)

The value(s) of the custom attribute, with a name (i.e. "Cotton") and an id

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "TEXT",
  • "values": [
    ]
}