The following table describes all of the attributes of shopper type properties that you can set through the Shopper Types endpoints of the Admin API:
Attribute | Description |
|---|---|
| String containing the display name of the property on the storefront. This attribute is localizable. If a value is not supplied, the attribute value is set to the name of the property. |
| Data type of the property. Valid values are |
| Data type for determining the type of user interface control for editing the value of the property. This attribute must be set to the same value as the |
| Boolean that specifies whether the property can be displayed on the storefront. If |
| Value to use for the property if a value is not specified. Defaults to null if not set explicitly. Must be set explicitly if the |
| Boolean that specifies whether the property value must be set. If this attribute is |
| String that determines whether the property appears as a choice in the Attributes field of the audience interface. For shopper profile properties, this value should be set to |
Note that in addition to the attributes listed in the table above, there are several more attributes whose values are returned when you issue a GET request to the /ccadmin/v1/shopperTypes/{id} endpoint. These attributes either cannot be set through the API, or if they are set, have no effect.
