Get an Entry

GET 
/v2/flows/:flowSlug/entries/:flowEntryID

• For Commerce, this endpoint retrieves an entry from a flow.
• For Product Experience Manager, this endpoint retrieves an entry from a template.

Request

Path Parameters

flowSlug stringrequired

The slug for the flow/template.

flowEntryID stringrequired

The ID of the entry.

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.

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

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.

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 (from schema)

{
  "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": "4abb8316-d0a2-4c91-bf29-4d19ba932227",
    "type": "entry",
    "meta": {
      "owner": "organization",
      "timestamps": {
        "created_at": "2018-05-10T15:28:59.192Z",
        "updated_at": "2018-05-10T15:28:59.192Z"
      }
    },
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/flows/products/entries/4abb8316-d0a2-4c91-bf29-4d19ba932227"
    }
  }
}

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