Get Prices by Price List Code

Retrieve Product Prices in a Specific Price List

This API allows external systems to retrieve all product prices associated with a specific price list by specifying the price list type (PRICELIST_TYPE) and its unique code (PRICELIST_CODE).

Each price is returned with its validity period (start_date, end_date), so the external system can store current and future prices and apply them on the correct date.

Product pricing

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 entities.

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

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.

PRICELIST_TYPE (A, V, F or R) and PRICELIST_CODE are required to specify the price list.

A - Purchase

Purchase price lists contain the purchase prices of products from suppliers, used for procurement with purchase orders.

V - Sale

F - Invoice

R - Retail (for outlets)

Main Success Scenario

The external system sends a GET request with PRICELIST_TYPE, PRICELIST_CODE and, optionally, a specific item_code.

If the request is successful, the system returns an HTTP 200 response with the paginated list of product prices associated with the specified price list and a nextCursor indicating whether there are more product prices to retrieve. If nextCursor is set, the external system must call this service again, setting cursor to the nextCursor value.

Response Example

Alternate Flows

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

Error Example

Invalid Price List: If PRICELIST_TYPE or PRICELIST_CODE is incorrect or does not exist, the API returns an error.

Error Example: invalid `PRICELIST_TYPE`

Error Example: `PRICELIST_CODE` not found

Empty Result: If no prices exist for the specified price list (or item_code), the prices array is empty.

Cursor & PageSize Used Together: If you specify cursor, you cannot specify pageSize: the page size is already contained in the cursor.

Error Example

Pagination Error: If an invalid cursor is 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, see 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

🟢200OK

application/json

Bodyapplication/json

Example

{
    "prices": [
        {
            "item_code": "H33BU2252--01011",
            "start_date": "1990-01-01",
            "end_date": "2999-12-31",
            "price": 1220
        },
        {
            "item_code": "NA3EG22K2--05099",
            "start_date": "1990-01-01",
            "end_date": "2024-07-25",
            "price": 370
        }
    ],
    "nextCursor": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTB2"
}

Get Prices by Price List Code

Retrieve Product Prices in a Specific Price List

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get Prices by Price List Code

Retrieve Product Prices in a Specific Price List#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve Product Prices in a Specific Price List

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js