Insert dimension

Adding Product Dimensions to a Dimension Group

This API allows an external system to add specific dimensions (e.g., sizes) to a predefined dimension group (e.g., "EU Sizes") associated with a given dimension type (e.g., "Size"). This functionality enables better organization of product attributes based on various size groupings.

dimension: The dimension value (e.g., "XL").

description_it: Description in Italian.

additional_description_it: Any additional description in Italian.

generic_name: Generic name for the dimension.

generic_name_it: Generic name in Italian.

dimension_grouping: Grouping category for the dimension.

position: Position or rank of the dimension within the group.

INFO

To learn more about how dimensions are managed, including defining dimension types, creating dimensional groups, and associating dimensions with products, please refer to our Product Dimensions

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 dimension_group must already exist and be created through the Insert dimension group API.

The dimension_type must be predefined (e.g., "TAGLIA").

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

Main Success Scenario

If the request is successful, the system will return an HTTP 200 response along with the internal program ID (prog_id) and the newly added dimension.

Example Success Response:

{
  "dimension": {
    "prog_id": 83434,
    "dimension": "XL"
  }
}

Alternate Flows

Dimension Type Not Found:
If the provided dimension_type does not exist in the system, the following error will be returned:

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

HTTP Status: 422 Unprocessable Entity

Dimension Group Not Found:
If the dimension_group does not exist, the following error will be returned:

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

HTTP Status: 422 Unprocessable Entity

Best Practices

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

Sequence Diagram

To correctly create a new Dimension, the DimensionGroup must already be registered, otherwise the service will report an error.

WARNING

Avoid simultaneous calls as they do not guarantee the correct insertion and validation of the "position" field.

Code Example in Node.js

This Node.js example demonstrates how to add a new dimension to a specified dimension group using the provided API.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Header Params

Body Params application/json

Example

{
    "dimension": "{{dimension}}",
    "description_it": "{{description_it}}",
    "additional_description_it":"{{additional_description_it}}",
    "generic_name":"{{generic_name}}",
    "generic_name_it":"{{generic_name_it}}",
    "dimension_grouping":"{{dimension_grouping}}",
    "position":"{{position}}"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Adding Product Dimensions to a Dimension Group#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Example in Node.js#

Request

Request Code Samples

Responses

Adding Product Dimensions to a Dimension Group

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Example in Node.js