Insert active dimensions

Create a New Dimension for a Product

This API allows the creation of a new dimension within a specified dimension group for a product. The client must specify the ITEM_CODE of the product, the DIMENSION_TYPE of the dimension to be added, and provide dimension_group and dimension_level in the request body.

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.

A valid ITEM_CODE and DIMENSION_TYPE must be provided as path parameters.

The specified dimension_group should exist in the 4ws.suite platform; otherwise, the API returns a 404 error.

Main Success Scenario

The client sends a POST request with the specified ITEM_CODE and DIMENSION_TYPE, along with dimension_group and dimension_level in the request body.

If the dimension is successfully created, the API responds with a success message and the internal prog_id of the newly created dimension.

{
  "dimension": {
    "prog_id": 542864
  }
}

Alternate Flows

Dimension Already Exists

If a dimension with the specified dimension_group and dimension_level already exists for the product, the API returns an error message indicating a unique constraint violation.

Response:

{
  "message": "Unique constraint error"
}

Dimension Group Not Found

If the specified dimension_group does not exist in the 4ws.suite platform, the API returns a 404 error.

Response:

{
  "message": "Dimension group not found"
}

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

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert active dimensions

Create a New Dimension for a Product#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Create a New Dimension for a Product

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js