Get a Field

GET 
/v2/fields/:flowFieldID

• For Commerce, this endpoint retrieves a field.
• For Product Experience Manager, this endpoint retrieves an attribute.

Request

Path Parameters

flowFieldID uuidrequired

The unique identifier of the flow/template whose field/attribute you want to retrieve.

Responses

200

OK

application/json

Schema

Schema

data object

id uuid

A unique identifier for a resource.

type string

Represents the type of object being returned.

field_type string

This field is immutable and cannot be updated. You can have the following field types:

• string
• integer
• boolean
• float
• date
• relationship

slug string

A short description for a field/attribute.

name string

The name of a field/attribute.

description string

A short description of a field/attribute.

required boolean

true if required on input, false if not. Always false if the field_type is a relationship.

default numberstringnull

A default value if none is supplied and a field/attribute is not required.

enabled boolean

order numbernull

Denotes the order in which this field is returned relative to the rest of the flow/template fields/attributes.

omit_null boolean

Hide this field/attribute from responses if the value is null.

validation_rules object[]

Array [

type string

Possible values: [enum, email, slug, between, one-to-many, one-to-one]

The validation you use depends on the field_type of the field/attribute. Each validation rule is expressed as a validation rule object.

options object

anyOf

MOD1

Array [

string

]

MOD2

from integerstring

to integerstring

to string

]

meta object

owner string

Possible values: [store, organization]

The resource owner, either organization or store.

timestamps object

created_at string

The date and time a resource is created.

updated_at string

The date and time a resource is updated.

links 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:

Property	Description
current	Always the current page
first	Always the first page
last	null if there is only one page.
prev	null if you are on the first page.
next	null if there is only one page.

self string

relationships 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 attached to the flow/template.

flow object

data object

id uuid

A unique identifier for a resource.

type string

Represents the type of object being returned.

Example (from schema)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "string",
    "field_type": "string",
    "slug": "string",
    "name": "string",
    "description": "string",
    "required": true,
    "enabled": true,
    "omit_null": true,
    "validation_rules": [
      {
        "type": "enum",
        "options": [
          null
        ],
        "to": "customer"
      }
    ],
    "meta": {
      "owner": "enum",
      "timestamps": {
        "created_at": "2023-10-11T13:02:25.293Z",
        "updated_at": "2023-10-11T13:02:25.293Z"
      }
    },
    "links": {
      "self": "https://euwest.api.elasticpath.com/v2/flows/3cf3ad3f-b12c-4a08-a6ab-05e6aab0122c/fields/c1c788d1-f1c7-4b90-938f-f158f3353c66"
    },
    "relationships": {
      "flow": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "flow"
        }
      }
    }
  }
}

default

{
  "data": {
    "id": "102b2087-d56a-45e7-bf1c-e9517716abb3",
    "type": "field",
    "field_type": "integer",
    "slug": "product-rating",
    "name": "Product Rating",
    "description": "Average rating as given by our users",
    "required": false,
    "default": null,
    "enabled": true,
    "validation_rules": [
      {
        "type": "between",
        "options": {
          "from": 1,
          "to": 5
        }
      }
    ],
    "order": 1,
    "omit_null": false,
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/flows/6d320b42-237d-4474-8452-d49f884d4ae1/fields/102b2087-d56a-45e7-bf1c-e9517716abb3"
    },
    "relationships": {
      "flow": {
        "data": {
          "id": "6d320b42-237d-4474-8452-d49f884d4ae1",
          "type": "flow"
        }
      }
    },
    "meta": {
      "owner": "organization",
      "timestamps": {
        "created_at": "2018-05-10T18:19:11.559Z",
        "updated_at": "2018-05-10T18:19:11.559Z"
      }
    }
  }
}

404

Bad request. Not Found.

application/json

Schema

Schema

errors Error[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Not Found",
      "status": 404
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": 500,
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Loading...