Update dimension grouping

Updating Price Dimension Grupping

This API enables updating an existing price band (dimension grouping) identified by the parameter DIMENSION_GROUPING. It allows for modifications to the localized descriptions that define the price band for products.

NOTE

For further information on dimension price dropping refer to Dimensiong group vs Dimension grouping

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Languages

This API supports multilingual descriptions through fields such as description_it (Italian), description_en (English), and description_fr (French). These fields allow localized data for international support.

Manage Languages

To understand how languages are managed, please refer to our Managing Languages Documentation.

Preconditions

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

The DIMENSION_GROUPING specified in the request URL must correspond to an existing price band; otherwise, the API will return an error.

At least one of the fields (description_it, description_en, description_fr) should be specified in the request payload to update the description data.

Main Success Scenario

The client sends a PATCH request with the updated descriptions, and the API successfully updates the corresponding price band. The response includes the prog_id and dimension_grouping, confirming the update.

{
  "dimensionGrouping": {
    "prog_id": 951,
    "dimension_grouping": "KID_4"
  }
}

INFO

To associate price dimension grupping with dimensions, specify the attribute dimension_grouping in the body of Insert dimension and Update dimension services.

Alternate Flows

Nonexistent Price Band:

If the specified DIMENSION_GROUPING does not exist, the API returns an error message stating that the dimension group was not found.

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

Invalid Data:

If no descriptions are provided or an invalid request structure is sent, the API may return a validation error.

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

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

{
    "description_it": "{{description_it}}"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "dimensionGrouping": {
        "prog_id": 951,
        "dimension_grouping": "KID_4"
    }
}

🟠401Authentication failed

🟠403Operation not allowed

🟠422Dimension group not found with dimension_group

🟠422Unique constraint error

Update dimension grouping

Updating Price Dimension Grupping#

Actors#

Languages#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Updating Price Dimension Grupping

Actors

Languages

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js