Attach multiple nodes

POST 
/pcm/products/attach_nodes

Assigns products to multiple hierarchies and their children nodes. You can apply a filter to search for the appropriate products to attach to a node. For general filtering syntax, see Filtering.

The following attributes and operators are supported.

Operator	Attribute	Description	Example
eq	sku, slug,upc_ean, manufacturer_part_num, name, templates, commodity_type, owner, product_types	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. For example, filter=eq(product_types,child)	filter=eq(name,some-name)
like	sku, slug,upc_ean, manufacturer_part_num, name	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	Checks if the values are included in the specified string. If they are, the condition is true. For product_types, you can specify more than one product type. For example, filter=in(product_types,child,bundle).	filter=in(id,some-id)

Request

application/json

Body

required

data objectrequired

filter stringrequired

Filters applied to search for appropriate products to attach to a node. See Attach multiple nodes.

node_ids string[]required

A list of node unique identifiers that you want to assign to the products.

Responses

200

This request assigns the products that you have selected to multiple hierarchies and their children nodes and returns the following.

application/json

Schema

Schema

meta object

nodes_attached integer

Number of nodes assigned to the products.

nodes_not_found string[]

A list of node unique identifiers that could not be identified.

Example (from schema)

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

created-product

Attach multiple nodes

{
  "meta": {
    "nodes_attached": 3,
    "nodes_not_found": []
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

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

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 [
status stringrequired
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"
        ]
      }
    }
  ]
}

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 [
status stringrequired
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...