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

Responses

201

Created

422

Bad request. The request failed validation.

500

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

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!