# Elastic Path Fields API

**Canonical:** https://apis.io/apis/elastic-path/elastic-path-fields-api/  
**Provider:** Elastic Path — https://apis.io/providers/elastic-path/  
**Base URL:** https://useast.api.elasticpath.com  
**Documentation:** https://developer.elasticpath.com/api

Elastic Path Fields API is one of 100 APIs that [Elastic Path](https://apis.io/providers/elastic-path/) publishes on the [APIs.io](https://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.

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 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` :::caution 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` :::caution 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`). |

## Machine-readable artifacts (2)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elastic-path/refs/heads/main/openapi/elastic-path-fields-api-openapi.yml
- **Documentation** — https://developer.elasticpath.com/api

## Other Elastic Path APIs (12)

- [Elastic Path GraphQL API](https://apis.io/apis/elastic-path/graphql-api/)
- [Elastic Path Account Addresses API](https://apis.io/apis/elastic-path/elastic-path-account-addresses-api/)
- [Elastic Path Account Authentication Settings API](https://apis.io/apis/elastic-path/elastic-path-account-authentication-settings-api/)
- [Elastic Path Account Cart Associations API](https://apis.io/apis/elastic-path/elastic-path-account-cart-associations-api/)
- [Elastic Path Account Management Authentication API](https://apis.io/apis/elastic-path/elastic-path-account-management-authentication-api/)
- [Elastic Path Account Members API](https://apis.io/apis/elastic-path/elastic-path-account-members-api/)
- [Elastic Path Account Membership API](https://apis.io/apis/elastic-path/elastic-path-account-membership-api/)
- [Elastic Path Account Membership Settings API](https://apis.io/apis/elastic-path/elastic-path-account-membership-settings-api/)
- [Elastic Path Account Tags API](https://apis.io/apis/elastic-path/elastic-path-account-tags-api/)
- [Elastic Path Accounts API](https://apis.io/apis/elastic-path/elastic-path-accounts-api/)
- [Elastic Path Administrator Latest Releases Catalog API API](https://apis.io/apis/elastic-path/elastic-path-administrator-latest-releases-catalog-api-api/)
- [Elastic Path Application Keys API](https://apis.io/apis/elastic-path/elastic-path-application-keys-api/)

## Tags

Fields

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/elastic-path/elastic-path-fields-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/elastic-path/.