Property

Markdown

A custom property definition.

Fields

  • propertyDefIdstring · property idrequired

    The property's id.

  • keystringrequired

    The immutable key spots use in customValues.

  • labelstringrequired

    The label buyers see.

  • kindstringrequired

    The kind; it decides the value's type and whether buyers can filter by it.

    shortLabellongSectionnumberdatecheckboxsingleSelect
  • ordernumberrequired

    Display order (ascending).

  • requiredbooleanoptional

    true when every spot must carry a value. Absent means false.

  • filterablebooleanrequired

    Whether buyers can filter by it (number, date, checkbox and singleSelect).

  • placeholderstring or nullrequired

    Editor placeholder text.

  • numUnitstring or nullrequired

    Unit label for number properties.

  • optionsarray of objectsrequired

    Options of checkbox and singleSelect properties.

    Show 4 fields
    • idstringrequired

      The option's immutable id: the value spots store.

    • labelstringrequired

      The option's label.

    • ordernumberrequired

      Display order (ascending).

    • archivedbooleanrequired

      true when the option is retired; stored values stay.

  • archivedbooleanrequired

    true when the property is archived; stored values stay.

  • schemaVersionnumberrequired

    The guide's property schema version after the last change.

Used by