Get All Dimension Price Grouping

Retrieve All Dimensions Price Grupping

This API retrieves the list of defined price bands (dimension groupings) that can be used to set product prices. The list is paginated, and if there are additional pages, the API response will indicate this with the moreRows field. Each dimension grouping includes information on various localized descriptions to support multi-language environments.

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

Product pricing

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

For more detail about product pricing features please refer to Product pricing and Defining Product Pricing.

The API supports pagination to navigate through large lists of dimensions price gruppings.

Paginated Responses

The service is paginated to handle large sets of data efficiently.
For detailed information on how to handle pagination, refer to our Paginated Responses

Languages

The API response includes multilingual descriptions. The fields description_it and description_en provide VAT operation descriptions in Italian and English, respectively.

Manage languages

For detailed information on how to handle languages, refer to our Managing Languages

Actors

API Client: The system or user initiating the request.

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

Preconditions

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

Pagination parameters cursor and nextCursor must be correctly configured in the request.

Main Success Scenario

The API returns a list of dimension groupings, including each grouping’s unique ID, name, and multilingual descriptions. The response also includes the nextCursor field, which guides the client in handling pagination.

Response Example

Alternate Flows

Authentication Error: If the client does not provide valid credentials, an error response is returned.

Error Example

Empty Result: If no collections exist, the dimension_grouping array will be empty.

Cursor & PageSize Used Together: Cursor and PageSize parameters in the request: If you specify a Cursor you cannot specify the page size. This information will already be contained within the cursor.

Error Example

Pagination Error: If invalid cursor parameters are provided, an error response is returned.

Rate Limiting: If the API rate limits are exceeded, the client must respect the retry interval indicated in the response headers Rate Limits.

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
        }
    ],
    "nextCursor": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTB2"
}

🟠401Authentication failed

🟠403Operation not allowed

🟠404Record not found

🟠422Invalid pageSize

🟠422Unique constraint error

Get All Dimension Price Grouping

Retrieve All Dimensions Price Grupping

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get All Dimension Price Grouping

Retrieve All Dimensions Price Grupping#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve All Dimensions Price Grupping

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js