Insert dimension grouping

Insert New Dimension Price Grupping

This API allows clients to insert a new price band (dimension grouping) that can be used to define product prices. Each price band must be uniquely identified and have a name and localized descriptions. If the dimension grouping already exists, the API returns a unique constraint error.

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

The API allows for multilingual descriptions to be specified in fields such as description_it (Italian) and description_en (English) to support a variety of locales.

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 value must be unique; otherwise, an error will occur.

Fields such as description_it and description_en should be populated for proper multilingual support.

Main Success Scenario

The API receives valid data, creates a new dimension grouping, and returns the unique program ID (prog_id) and the dimension_grouping value in the response.

{
  "dimensionGrouping": {
    "prog_id": 899,
    "dimension_grouping": "0"
  }
}

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

Duplicate Dimension Grouping:

If the provided dimension_grouping already exists, the API returns an error with a message indicating a unique constraint violation.

{
  "message": "Unique constraint error"
}

Invalid Data:

If any required fields are missing or contain invalid data, the API may return an error indicating the validation issue.

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 ********************

Header Params

Body Params application/json

Example

{
    "dimension_grouping": "{{dimension_grouping}}",
    "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 grouping

Insert New Dimension Price Grupping#

Actors#

Languages#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Insert New Dimension Price Grupping

Actors

Languages

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js