Update dimension group

Updating Descriptions of a Product Dimension Group

This API allows an external system to update the descriptions of a dimension group that is associated with product attributes like size or color. The dimension group can have descriptions in different languages, and the group is defined by the dimension type (e.g., size or color) and the dimension group (e.g., "EU Sizes").

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 already exist in the system.

The dimension_group must already exist and be associated with the given dimension_type.

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 updated internal program ID (prog_id) and the dimension_group.

Example Success Response:

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

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 for the specified dimension_type, 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

Code Example in Node.js

This Node.js example demonstrates how to update the descriptions of a 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

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Update dimension group

Updating Descriptions of a Product Dimension Group#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Example in Node.js#

Request

Request Code Samples

Responses

Updating Descriptions of a Product Dimension Group

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Example in Node.js