Update hierarchy

Updating a Product Hierarchy

This API allows an external system, such as an e-commerce platform or B2B ordering system, to update an existing product hierarchy. A product hierarchy represents the structured relationship between different product categories, such as family, department, and genre. To update a hierarchy, all parent hierarchy levels and types must be specified, along with the hierarchy level being updated.

Languages

To understand how languages are managed, please refer to our Managing Languages Documentation.

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Preconditions

The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

Main Success Scenario

The external system sends a PATCH request with the parent hierarchy levels and the details of the hierarchy to be updated.

If the parent hierarchy levels, types, and the hierarchy level exist, the system updates the hierarchy and returns an HTTP 200 response.

Successful Response:

{
  "hierarchy": {
    "prog_id": 164951,
    "hierarchy_level": "WOMAN1"
  }
}

WARNING

The update affects all products whose classification is subject to change.

Alternate Flows

Hierarchy Level Already Exists: If the hierarchy level already exists and no changes were made, the API may return an HTTP 422 error:

{
  "message": "hierarchy_level with {hierarchy_level} already exists"
}

Hierarchy Type Not Found: If the hierarchy_type does not exist, the API returns an HTTP 422 error:

{
  "message": "hierarchy_type with {hierarchy_type} not found"
}

Parent Hierarchy Not Found: If one of the parent hierarchy types or levels does not exist, the API returns an HTTP 422 error:

{
  "message": "parent_hierarchy_type with {parent_hierarchy_type} not found"
}

Callback Response

Not applicable for this use case.

Sequence Diagram

Best Practices

Please refer to Best Practices for Error Handling in External System for best practices on implementation.

Code Examples in Node.js

Below is an example of how to update an existing product hierarchy using Node.js:

This Node.js example demonstrates how to send a request to update a product hierarchy and handle potential errors while logging the results for audit purposes.

Request

Header Params

Body Params application/json

Example

 {
    "parent_hierarchy_type1":"FAMIGLIA",
    "parent_hierarchy_level1":"MABI",
    "parent_hierarchy_type2":"REPARTO",
    "parent_hierarchy_level2":"ABB",
    "level_number":3,
    "hierarchy_type": "GENERE",
    "hierarchy_level": "WOMAN1",
    "description_it": "Donna",
    "active":false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Updating a Product Hierarchy#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Callback Response#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Updating a Product Hierarchy

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Callback Response

Sequence Diagram

Code Examples in Node.js