Create an Entry

POST 
https://euwest.api.elasticpath.com/v2/flows/:flowSlug/entries

• For Commerce, this endpoint creates an entry for a flow.
• For Product Experience Manager, this endpoint creates an entry for a template.

Request

Path Parameters

flowSlug stringrequired

The slug for the flow/template you want to create an entry for.

application/json

Bodyrequired

data object

Specifies the type of the resource object.

FIELD_SLUGstring

Where FIELD_SLUG is the slug for each field/attribute on this flow/template along with the corresponding value. You must provide a field slug and a value for the entry. You can have multiple field slugs if they are related to the flow/template.

typestring

Represents the type of object being returned.

Responses

201

Created

application/json

Schema

Schema

data object

idstring<uuid>

A unique identifier for a resource.

Example: 00000000-0000-0000-0000-000000000000

typestring

Represents the type of object being returned.

Example: entry

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/d2a9b22a-b4b0-456b-bbc7-d8723aaffa84

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

property name*string

There can be a :fieldSlug attribute for each field/attribute attached to a flow/template. The type depends on the field type.

Example (auto)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "entry",
    "links": {
      "self": "https://euwest.api.elasticpath.com/v2/flows/d2a9b22a-b4b0-456b-bbc7-d8723aaffa84"
    },
    "meta": {
      "owner": "enum",
      "timestamps": {
        "created_at": "2023-10-11T13:02:25.293Z",
        "updated_at": "2023-10-11T13:02:25.293Z"
      }
    }
  }
}

default

{
  "data": {
    "id": "10fe2aca-09fb-42fe-a1d4-081134320641",
    "type": "entry",
    "meta": {
      "owner": "organization",
      "timestamps": {
        "created_at": "2021-10-26T17:10:56.329Z",
        "updated_at": "2021-10-26T17:10:56.329Z"
      }
    },
    "links": {
      "self": "https://epcc-integration.global.ssl.fastly.net/v2/flows/products/entries/10fe2aca-09fb-42fe-a1d4-081134320641"
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
statusinteger<int>required
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"
    }
  ]
}

404

Bad request. Not Found.

application/json

Schema

Schema

errors Error[]required
Array [
statusinteger<int>required
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": [
    {
      "title": "Not Found",
      "status": 404
    }
  ]
}

422

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
statusinteger<int>required
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 [
statusinteger<int>required
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/flows/:flowSlug/entries");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"FIELD_SLUG\": \"string\",\n    \"type\": \"string\"\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

Parameters

flowSlug — pathrequired

Body required

• Example (from schema)
• default

{
  "data": {
    "FIELD_SLUG": "string",
    "type": "string"
  }
}

ResponseClear

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