Create a Field

POST 
https://euwest.api.elasticpath.com/v2/fields

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

Request

application/json

Bodyrequired

data object
defaultnumber
Specifies a default value for a field/attribute if no value is provided and the field/attribute is required.
descriptionstring
A description for a field/attribute.
enabledboolean
field_typestring
This field is immutable and cannot be updated. You can have the following field types:
• string
• integer
• boolean
• float
• date
• relationship
namestring
The name of a field/attribute.
ordernumber
Denotes the order in which a field/attribute is returned relative to the rest of flow fields/template attributes.
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
iduuid
A unique identifier for a resource.
Example: 00000000-0000-0000-0000-000000000000
typestring
Represents the type of object being returned.
Example: flow
requiredboolean
true if required on input, false if not. Always false if the field_type relationship.
slugstring
A unique identifier of a field/attribute.
typestring
Represents the type of object being returned.
validation_rules object[]
An array of validation rule objects. See Field Validation Rules.
Array [
typestring
The validation you use depends on the field_type of the field/attribute. Each validation rule is expressed as a validation rule object.
Possible values: [enum, email, slug, between, one-to-many, one-to-one]
Example: enum
options object
anyOf
MOD1
Array [
string
]
MOD2
frominteger | string
Example: 1
tointeger | string
Example: 5
tostring
Example: customer
]

Responses

201

Created

application/json

Schema

Schema

data object
iduuid
A unique identifier for a resource.
Example: 00000000-0000-0000-0000-000000000000
typestring
Represents the type of object being returned.
field_typestring
This field is immutable and cannot be updated. You can have the following field types:
• string
• integer
• boolean
• float
• date
• relationship
slugstring
A short description for a field/attribute.
namestring
The name of a field/attribute.
descriptionstring
A short description of a field/attribute.
requiredboolean
true if required on input, false if not. Always false if the field_type is a relationship.
defaultnumber | string | null
A default value if none is supplied and a field/attribute is not required.
enabledboolean
ordernumber | null
Denotes the order in which this field is returned relative to the rest of the flow/template fields/attributes.
omit_nullboolean
Hide this field/attribute from responses if the value is null.
validation_rules object[]
Array [
typestring
The validation you use depends on the field_type of the field/attribute. Each validation rule is expressed as a validation rule object.
Possible values: [enum, email, slug, between, one-to-many, one-to-one]
Example: enum
options object
anyOf
MOD1
Array [
string
]
MOD2
frominteger | string
Example: 1
tointeger | string
Example: 5
tostring
Example: customer
]
meta object
ownerstring
The resource owner, either organization or store.
Possible values: [store, organization]
Example: enum
timestamps object
created_atstring
The date and time a resource is created.
Example: 2023-10-11T13:02:25.293Z
updated_atstring
The date and time a resource is updated.
Example: 2023-10-11T13:02:25.293Z
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.
selfstring
Example: https://euwest.api.elasticpath.com/v2/flows/3cf3ad3f-b12c-4a08-a6ab-05e6aab0122c/fields/c1c788d1-f1c7-4b90-938f-f158f3353c66
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
iduuid
A unique identifier for a resource.
Example: 00000000-0000-0000-0000-000000000000
typestring
Represents the type of object being returned.
Example: flow

Example (auto)

{
  "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": [
          "string"
        ],
        "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": {
    "type": "field",
    "name": "Product Rating",
    "slug": "product-rating",
    "field_type": "integer",
    "validation_rules": [
      {
        "type": "between",
        "options": {
          "from": 1,
          "to": 5
        }
      }
    ],
    "description": "Average rating as given by our users",
    "required": false,
    "default": 0,
    "enabled": true,
    "order": 1,
    "omit_null": false,
    "relationships": {
      "flow": {
        "data": {
          "type": "flow",
          "id": "e4145c27-aba1-46af-81a3-58f5e1cf7f15"
        }
      }
    }
  }
}

422

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
statusintrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "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"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": 400,
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

500

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

application/json

Schema

Schema

errors Error[]required
Array [
statusintrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "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"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://euwest.api.elasticpath.com/v2/fields");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"default\": 0,\n    \"description\": \"string\",\n    \"enabled\": true,\n    \"field_type\": \"string\",\n    \"name\": \"string\",\n    \"order\": 0,\n    \"relationships\": {\n      \"flow\": {\n        \"data\": {\n          \"id\": \"00000000-0000-0000-0000-000000000000\",\n          \"type\": \"flow\"\n        }\n      }\n    },\n    \"required\": true,\n    \"slug\": \"string\",\n    \"type\": \"string\",\n    \"validation_rules\": [\n      {\n        \"type\": \"enum\",\n        \"options\": [\n          \"string\"\n        ],\n        \"to\": \"customer\"\n      }\n    ]\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Body required

• Example (from schema)
• default

{
  "data": {
    "default": 0,
    "description": "string",
    "enabled": true,
    "field_type": "string",
    "name": "string",
    "order": 0,
    "relationships": {
      "flow": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "flow"
        }
      }
    },
    "required": true,
    "slug": "string",
    "type": "string",
    "validation_rules": [
      {
        "type": "enum",
        "options": [
          "string"
        ],
        "to": "customer"
      }
    ]
  }
}

ResponseClear

Click the Send API Request button above and see the response here!