Fields
With fields, you can:
- in Commerce, use a field in your flows to represent single field of data (for example a
Product Rating) to be applied to an entity - in Product Experience Manager, use an attribute in your template to attach a characteristic like
colorto a product.
A field/attribute represents a single piece of data. All fields/attributes have a field_type (string, integer, boolean, date or relationship), a default value, and an optional set of validation rules.
- Custom names and values prefixed with
$are not supported. - There is a hard limit of 100 fields per flow.
- You can configure default values for fields. If you choose to do so, you must ensure that your default field values comply with your validation rules.
Field/Attribute Validation Rules
When creating a field/attribute, you can add validation to the values that are stored. The validation you use depends on the field_type of the field/attribute. Each validation rule is expressed as a validation rule object.
string / enum
Must be one of a predefined collection of strings. If you leave the field blank or enter an incorrect value then an Invalid Value error is displayed.
| Attribute | Type | Description |
|---|---|---|
type | string | enum |
options | array[string] | An array of valid string values. |
string / email
Must be a valid email address.
| Attribute | Type | Description |
|---|---|---|
type | string | email |
string / slug
Can contain only letters, numbers, hyphens and underscores.
| Attribute | Type | Description |
|---|---|---|
type | string | slug |
integer / between
Must be between the two provided values.
| Attribute | Type | Description |
|---|---|---|
type | string | enum |
options | object | An object containing from and to integers. |
integer / enum
Must be one of a predefined collection of integers.
| Attribute | Type | Description |
|---|---|---|
type | string | enum |
options | array[integer] | An array of valid integer values. |
float / between
Must be between the two provided values.
| Attribute | Type | Description |
|---|---|---|
type | string | enum |
options | object | An object containing from and to floats. |
float / enum
Must be one of a predefined collection of floats.
| Attribute | Type | Description |
|---|---|---|
type | string | enum |
options | array[float] | An array of valid float values. |
date / enum
Must be one of a predefined collection of dates.
| Attribute | Type | Description |
|---|---|---|
type | string | enum |
options | array[string] | An array of valid date values as strings (YYYY-MM-DD HH:MM:SS - time is optional). |
relationship / one-to-many
This only applies to Commerce. You cannot use relationships in Product Experience Manager templates.
Allows multiple relationships to be created.
| Attribute | Type | Description |
|---|---|---|
type | string | one-to-many |
to | string | The entity type you are making relationships with in singular form (for example, product). |
relationship / one-to-one
This only applies to Commerce. You cannot use relationships in Product Experience Manager templates.
Allows only a single relationships to be created on an entry.
| Attribute | Type | Description |
|---|---|---|
type | string | one-to-one |
to | string | The entity type you are making relationships with in singular form (for example, customer). |
📄️ Get all Fields
- For Commerce, this endpoint retrieves all fields in a flow.
📄️ Create a Field
- For Commerce, this endpoint creates a field.
📄️ Get a Field
- For Commerce, this endpoint retrieves a field.
📄️ Update a Field
- For Commerce, this endpoint updates a field.
📄️ Delete a Field
- For Commerce, this endpoint deletes a field.
📄️ Get all Fields by Flow
Get all Fields by Flow