Get product grouping

Product Price Grouping Retrieval

This API allows clients to retrieve the price bands (or "dimension groupings") available for a specific product variant.

The API returns an array of active price bands in multiple languages, which can be used to product information to different customer segments based on pricing tiers.

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 price groupings.

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 Product price grouping 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

If the request is successful, the system will return an HTTP 200 response with the paginated list of price grouping and a nextCursor indicating whether there are more price grouping to retrieve. If nextCursor is setted, the external system must be call again, this service, setting cursor as nextCursor value.

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

Responses

🟢200Response

application/json

Body

Example

{
    "dimension_groupings": [
        {
            "dimension_grouping": "BABY",
            "description_it": "Neonato"
        },
        {
            "dimension_grouping": "KID",
            "description_it": "Bambino"
        },
        {
            "dimension_grouping": "TEEN",
            "description_it": "Adolescente"
        }
    ],
    "nextCursor": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTB2"
}

Get product grouping

Product Price Grouping Retrieval

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get product grouping

Product Price Grouping Retrieval#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Product Price Grouping Retrieval

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js