Insert hierarchy

Creating a Product Hierarchy

This API allows an external system, such as an e-commerce platform or B2B ordering system, to create a new product hierarchy. A product hierarchy helps structure product categories in a parent-child relationship, such as family, department, and genre. When creating a new hierarchy level, all parent hierarchy types and levels must be specified.

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 POST request with the parent hierarchy levels and the details of the new hierarchy to be created.

If the specified parent hierarchy levels and types exist, the new hierarchy level is created, and an HTTP 200 response is returned with the details of the new hierarchy.

Successful Response:

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

Alternate Flows

Hierarchy Level Already Exists: If the hierarchy_level specified in the request already exists, the API will return an HTTP 422 error:

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

Hierarchy Type Not Found: If the specified 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 any of the parent hierarchy types or levels do not exist, the API will return 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 create a product hierarchy using Node.js:

This Node.js example demonstrates how to make a POST request to create a product hierarchy, handle errors, and log the response for troubleshooting purposes.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

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": "WOMAN33",
    "description_it": "Donna",
    "active":true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Creating 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

Creating a Product Hierarchy

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Callback Response

Sequence Diagram

Code Examples in Node.js