How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Elastic Path

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, at version 25.1201.6902711.

Requests are made against 2 base URLs: https://euwest.api.elasticpath.com, https://useast.api.elasticpath.com.

6 operations 3 paths 10 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
25.1201.6902711
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Elastic Path Fields API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). 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.

Fields 6

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…

GET
/v2/fields
Get all Fields
getAllFields → 200400500
POST
/v2/fields
Create a Field
createAField body → 201422500
GET
/v2/fields/{flowFieldID}
Get a Field
getAField 1 param → 200404500
PUT
/v2/fields/{flowFieldID}
Update a Field
updateAField 1 param body → 200404422500
DELETE
/v2/fields/{flowFieldID}
Delete a Field
deleteAField 1 param → 204404500
GET
/v2/flows/{flowSlug}/fields
Get all Fields by Flow
getAllFieldsByFlow 1 param → 200404500

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.

FieldUpdateRequest
object
1 property
FieldValidationRules
object
An array of validation rule objects. See [Field/attribute Validation Rules](fieldattribute-validation-rules).
3 properties
Meta
object
2 properties
FieldRelationships
object
Relationships are established between different flow/template entities. For example, a field/attribute is related to a flow/template, as the field/attribute is…
1 property 1 required
ErrorResponse
object
1 property 1 required
FieldRequest
object
1 property 1 required
Error
object
5 properties 2 required
Field
object
15 properties
FieldLinks
object
Links allow you to move between requests. Single entities use a self parameter with a link to that specific resource. Listing pages use the following: | Proper…
1 property
UUID
string
A unique identifier for a resource.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-fields-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
AE Profile APIs.io
Elastic Path Account Addresses API
AE Profile APIs.io
Elastic Path Account Authentication Settings API
AE Profile APIs.io
Elastic Path Account Cart Associations API
AE Profile APIs.io
Elastic Path Account Management Authentication API
AE Profile APIs.io
Elastic Path Account Members API
AE Profile APIs.io
Elastic Path Account Membership API
AE Profile APIs.io
Elastic Path Account Membership Settings API
AE Profile APIs.io
Elastic Path Account Tags API
AE Profile APIs.io
Elastic Path Accounts API
AE Profile APIs.io
Elastic Path Administrator Latest Releases Catalog API API
AE Profile APIs.io
Elastic Path Application Keys API
AE Profile APIs.io
#Fields
← Back to E APIs
API Details
ID
elastic-path:elastic-path-fields-api
Base URL
https://useast.api.elasticpath.com
Docs
https://developer.elasticpath.com/api
Provider
Elastic Path
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=elastic-path-fields-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/elastic-path-fields-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Elastic Path Fields API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.