Get Dimension Price Grouping

Retrive One Dimension Price Grouping

This API allows retrieval of specific price grouping information by specifying the parameter {DIMENSION_GROUPING}. This data is used to define product pricing by grouping dimensions (such as age or size categories).

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 response includes description_it for Italian, description_en for English, and other language fields to support localization as needed.

Preconditions

The {DIMENSION_GROUPING} must be valid and registered 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

The API returns the details of the requested dimension grouping, including its unique ID, grouping name, and descriptions in multiple languages.

{
  "dimension_grouping": {
    "prog_id": 27975001,
    "dimension_grouping": "BABY",
    "description_it": "Fascia Baby",
    "description_en": "Baby",
    "description_de": "Baby",
    "description_es": "Baby",
    "description_fr": "Baby",
    "description_pt": "Baby",
    "description_ru": "Baby",
    "description_ar": "Baby",
    "description_ja": "Baby",
    "description_zh": "Baby",
    "erasable": true
  }
}

Once you retrieve the dimension groups for a product, you can proceed to insert their prices using the Insert Price API.

Alternate Flows

Non-Existent Dimension Grouping:

If the specified {DIMENSION_GROUPING} does not exist, the API returns an error indicating "Dimension group not found with dimension_group: {{dimension_group}}."

Successful Response:

Returns a JSON object containing the dimension grouping details, including descriptions in different languages and the erasable attribute, which indicates if the grouping can be deleted.

Error Response:

If the dimension grouping is not found, the following error response is returned:

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

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

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200Success

application/json

Body

Example

{
    "dimension_grouping": {
        "prog_id": 27975001,
        "dimension_grouping": "BABY",
        "description_it": "Fascia Baby",
        "description_en": "Baby",
        "description_de": "Baby",
        "description_es": "Baby",
        "description_fr": "Baby",
        "description_pt": "Baby",
        "description_ru": "Baby",
        "description_ar": "Baby",
        "description_ja": "Baby",
        "description_zh": "Baby",
        "erasable": true
    }
}

🟠401Authentication failed

🟠403Operation not allowed

🟠404Record not found

🟠422Unique constraint error

Get Dimension Price Grouping

Retrive One Dimension Price Grouping

Actors

Languages

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get Dimension Price Grouping

Retrive One Dimension Price Grouping#

Actors#

Languages#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrive One Dimension Price Grouping

Actors

Languages

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js