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

Responses

201

Returns information related to associated products.

400

Bad request. The request failed validation.

403

Forbidden

404

Bad Request. Not Found.

409

Write conflict detected

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

• Example (from schema)
• create-product-association

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

ResponseClear

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