Create an Entry Relationship

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

• In Commerce, create an entry relationship to one or more resources. If any relationships already exist, the ones made in the request are added to them.
• In Product Experience Manager, create an entry relationship with the product to which you want to associate the template.

Request

Path Parameters

flowSlug stringrequired

The slug of the flow/template that the entry belongs to.

flowFieldSlug stringrequired

The slug of the field/attribute that the relationship belongs to.

flowEntryID stringrequired

The ID of the entry you are requesting.

application/json

Bodyrequired

data object[]
The data to be stored.
Array [
iduuid
A unique identifier for a resource.
Example: 00000000-0000-0000-0000-000000000000
typestring
The resource type of the object.
]

Responses

201

Created

application/json

Schema

Schema

data object[]
Array [
iduuid
A unique identifier for a resource.
Example: 00000000-0000-0000-0000-000000000000
typestring
Represents the type of object being returned.
Example: brand
]

Example (auto)

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "brand"
    }
  ]
}

default

{
  "data": [
    {
      "type": "brand",
      "id": "0d28e5b6-f615-4e1c-b038-275cfde97927"
    }
  ]
}

404

Bad request. Not Found.

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": [
    {
      "title": "Not Found",
      "status": 404
    }
  ]
}

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/flows/:flowSlug/entries/:flowEntryID/relationships/:flowFieldSlug");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": [\n    {\n      \"id\": \"00000000-0000-0000-0000-000000000000\",\n      \"type\": \"string\"\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

Parameters

flowSlug — pathrequired

flowFieldSlug — pathrequired

flowEntryID — pathrequired

Body required

• Example (from schema)
• default

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "string"
    }
  ]
}

ResponseClear

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