Insert dimension group

Registering Product Dimension Groups

This API allows an external system to register a new dimension group for product attributes. Each dimension group can have a set of dimensions associated with it. For example, if the dimension type is TAGLIA (size), the group could be "EU Sizes" with dimensions like S, M, L. If the dimension type is COLORE (color), the group might be "Pastel Palette" or "Uniposca Palette."

dimension_type: The type of dimension (e.g., size, color). It is defined at the start of the project by Sinesy and the client. Example values could include TAGLIA, COLORE, LUNGHEZZA.

dimension_group: The group identifier, such as "EU Sizes" or "Pastel Palette."

description_it: Description of the dimension group in Italian.

description_en: Description of the dimension group in English.

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_type must be predefined by the client or by Sinesy at the start of the project.

The dimension_group must not already exist in the system.

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 newly created prog_id and dimension_group.

Example Success Response:

{
  "dimensionGroup": {
    "prog_id": 1000120,
    "dimension_group": "123"
  }
}

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 Already Exists:
If the dimension_group already exists, the following error will be returned:

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

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

Code Example in Node.js

This Node.js example shows how to create a new 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

Body Params application/json

Example

{
    "dimension_group": "{{dimension_group}}",
    "description_it": "{{description_it}}",
    "description_en": "{{description_en}}"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert dimension group

Registering Product Dimension Groups#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Example in Node.js#

Request

Request Code Samples

Responses

Registering Product Dimension Groups

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Example in Node.js