Create a Relationship between a Product with one or more Products

POST 
https://euwest.api.elasticpath.com/pcm/products/:productID/custom-relationships/:customRelationshipSlug

• You can associate a product with up to 2000 other products.
• You do not need to attach a custom relationship to products beforehand, this will be done automatically by this endpoint.
• This is a partial update, so if you make a request to this endpoint multiple times with different products in each request, they will not be overwritten but will be appended to the related products list.

If you want to remove a relationship between products, see Delete a Relationship between a product with one or more products.

Prerequisites

• A Custom Relationship has been created, see create a Custom Relationship.
• A Product has been created for the relationship to be based from.
• One or many Product have been created for the product to relate to.

Request

Path Parameters

productID stringrequired

A unique identifier for the product.

customRelationshipSlug stringrequired

A custom relationship slug.

Body

data object[]required
Array [
idstringrequired
The ID of the product you want to relate.
typestringrequired
This represents the type of resource being returned. Always product.
Possible values: [product]
attributes object
sort_orderintegernullable
The order in which the product to product should be displayed in relation to others. A lower value represents a higher priority in the display order. If set to NULL, the sort order will be removed.
Example: 5
]

Responses

201

Returns information related to associated products.

Schema:SchemaExample (auto)

Schema

meta object
associated_productsstring[]
A list of product IDs that have been successfully associated with this custom relationship.
Example: ["68c48149-0e94-4ef2-93d5-8d5f3774980a","ab4826d1-4a5a-4951-a2a5-98058899f891"]
products_not_associated object[]
A list of products that could not be associated, including the reasons why.
Array [
IDstring
The ID of the product that could not be associated.
Example: 97b7fac2-91dd-4755-81b0-bdffe8e7eabd
Detailsstring
Details about why the product could not be associated.
Example: could not find product
]
ownerstring
The owner of the resource.
Example: store
timestamps object
created_atstring<date-time>
The date and time the resource was created.
Example: 2024-08-08T09:29:08.295Z
updated_atstring<date-time>
The date and time the resource was last updated.
Example: 2024-08-08T09:29:08.295Z

{
  "meta": {
    "associated_products": [
      "68c48149-0e94-4ef2-93d5-8d5f3774980a",
      "ab4826d1-4a5a-4951-a2a5-98058899f891"
    ],
    "products_not_associated": [
      {
        "ID": "97b7fac2-91dd-4755-81b0-bdffe8e7eabd",
        "Details": "could not find product"
      },
      {
        "ID": "a0ef3291-2ec1-4d7d-9d6d-1705ae01bb99",
        "Details": "product already has 5 custom relationships, cannot associate more as it has reached the limit of 5 custom relationships"
      },
      {
        "ID": "bde79675-4783-40b7-8a7e-ac6df41459c6",
        "Details": "product already has 5 custom relationships, cannot associate more as it has reached the limit of 5 custom relationships"
      },
      {
        "ID": "aaddd5f4-a5f8-42e8-be9a-097986f22e58",
        "Details": "exceeded maximum allowed associations (2000). Please review and try again"
      }
    ],
    "owner": "store",
    "timestamps": {
      "created_at": "2024-08-08T09:29:08.295Z",
      "updated_at": "2024-08-08T09:29:08.295Z"
    }
  }
}

400

Bad request. The request failed validation.

Schema:SchemaExample (auto)

Schema

errors undefined[]required
Array [
statusstringrequired
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"]}
]

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

403

Forbidden

Schema:SchemaExample (auto)

Schema

errors undefined[]required
Array [
statusstringrequired
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"]}
]

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

404

Bad Request. Not Found.

Schema:SchemaExample (auto)

Schema

errors undefined[]required
Array [
statusstringrequired
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"]}
]

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

409

Write conflict detected

Schema:SchemaExample (auto)

Schema

errors undefined[]required
Array [
statusstringrequired
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"]}
]

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

422

Bad request. The request failed validation.

Schema:SchemaExample (auto)

Schema

errors undefined[]required
Array [
statusstringrequired
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"]}
]

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

500

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

Schema:SchemaExample (auto)

Schema

errors undefined[]required
Array [
statusstringrequired
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"]}
]

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

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/pcm/products/:productID/custom-relationships/:customRelationshipSlug");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": [\n    {\n      \"id\": \"string\",\n      \"type\": \"product\",\n      \"attributes\": {\n        \"sort_order\": 5\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

Parameters

productID — pathrequired

customRelationshipSlug — pathrequired

Body

{
  "data": [
    {
      "id": "string",
      "type": "product",
      "attributes": {
        "sort_order": 5
      }
    }
  ]
}

ResponseClear

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