Elastic Path Fields API
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 `color` to 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.:::caution- 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 RulesWhen 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`:::cautionThis 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`:::cautionThis 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`). |
Elastic Path Fields API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Fields. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 6 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.
Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic Path Fields API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
By default, every request must be authenticated.
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
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…
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Field (15 properties), Error (5 properties), FieldValidationRules (3 properties), Meta (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Path 12
Other APIs Elastic Path publishes across the network.