Detach multiple nodes

POST 
https://euwest.api.elasticpath.com/pcm/products/detach_nodes

Dissociates products from multiple hierarchies and their children nodes. You can apply filters to search for the appropriate products to detach. For general filtering syntax, see Filtering.

The following attributes and operators are supported.

Operator	Attribute	Description	Example
eq	id, sku, slug, upc_ean, manufacturer_part_num, name, templates, commodity_type, owner, product_types, parent_id, tags, status, has_nodes (false only), created_at, updated_at, external_ref, description	Equals. Checks if the values of two operands are equal. If they are, the condition is true. For product_types, you can only specify one product type. Note: has_nodes can only be filtered as false.	?filter=eq(name,some-name)
like	sku, slug, upc_ean, manufacturer_part_num, name, tags, description, external_ref	Like. Checks if the operand contains the specified string. Wildcards are supported.	?filter=like(name,*some-name*)
in	id, name, sku, slug, upc_ean, manufacturer_part_num, product_types, parent_id, tags, external_ref	Checks if the values are included in the specified list. If they are, the condition is true. For product_types, you can specify more than one product type.	?filter=in(id,some-id)
gt	id, created_at, updated_at, external_ref	Greater than. Checks if the value of the field is greater than the given value.	?filter=gt(updated_at,2024-01-01T00:00:00Z)
ge	id, created_at, updated_at, external_ref	Greater than or equal to. Checks if the value of the field is greater than or equal to the given value.	?filter=ge(created_at,2023-01-01T00:00:00Z)
lt	id, created_at, updated_at, external_ref	Less than. Checks if the value of the field is less than the given value.	?filter=lt(updated_at,2025-01-01T00:00:00Z)
le	id, created_at, updated_at, external_ref	Less than or equal to. Checks if the value of the field is less than or equal to the given value.	?filter=le(created_at,2022-01-01T00:00:00Z)
eq (extensions)	extensions.book.isbn	Filters using a nested extension field.	?filter=eq(extensions.book.isbn,1765426)

Request

application/json

Bodyrequired

data objectrequired
filterstringrequired
You can apply filters to search for the appropriate products to detach. See Detach multiple nodes.
Example: eq(sku,book)
node_idsstring[]required
A list of node unique identifiers that you want to assign to the products.
Example: ["123"]

Responses

200

The request dissociates the products that you have selected from multiple hierarchies and their children and returns the following.

application/json

Schema

Schema

meta object
nodes_detachedinteger
Number of nodes dissociated from the products.
nodes_not_foundstring[]
A list of node unique identifiers that could not be identified.
Example: ["123"]

Example (auto)

{
  "meta": {
    "nodes_detached": 0,
    "nodes_not_found": [
      "123"
    ]
  }
}

created-product

Detach multiple nodes

{
  "meta": {
    "nodes_detached": 1,
    "nodes_not_found": []
  }
}

400

Bad request. The request failed validation.

application/json

Schema

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

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

bad-request

{
  "errors": [
    {
      "title": "Bad Request",
      "detail": "Could not parse the supplied filter",
      "status": "400"
    }
  ]
}

422

Bad request. The request failed validation.

application/json

Schema

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

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

failed-validation

{
  "errors": [
    {
      "title": "Failed Validation",
      "status": "422",
      "detail": "<XYZ> can not be empty"
    }
  ]
}

500

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

application/json

Schema

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

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/pcm/products/detach_nodes");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"filter\": \"eq(sku,book)\",\n    \"node_ids\": [\n      \"123\"\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

Body required

• Example (from schema)
• product-attach-nodes

{
  "data": {
    "filter": "eq(sku,book)",
    "node_ids": [
      "123"
    ]
  }
}

ResponseClear

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