Get price lists by type

Retrieve Price Lists by Type

This API allows external systems to retrieve paginated lists of price lists filtered by a specified type. Price lists can be filtered by type (Sales, Invoice, Purchase, etc.) using the PRICELIST_TYPE parameter in the path.

The primary use case of this API is to enable external systems to retrieve price list information filtered by type. Each price list includes metadata like currency, start and end dates, multilingual descriptions, and whether the list is active.

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

Languages

The API response includes multilingual descriptions. The fields description_it and description_en provide Price lists 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.

PRICELIST_TYPE (e.g., V, A, or F) 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 V.

If the request is successful, the system will return an HTTP 200 response with the paginated list of price lists and a nextCursor indicating whether there are more price lists 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

If PRICELIST_TYPE or PRICELIST_CODE is incorrect or does not exist, the API will return an error.

Error Example: invalid `PRICELIST_TYPE`

Error Example: `PRICELIST_CODE` not found

Empty Result: If no collections exist, the entities 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

🟢200OK

application/json

Body

Example

{
    "price_lists": [
        {
            "prog_id": 11979,
            "price_list_type": "A",
            "price_list_code": "00008888",
            "description_it": "Listino sartoria 00008888",
            "description_en": "Tailor list 00008888",
            "description_es": "Tailor list 00008888",
            "currency": "EUR",
            "start_date": "2022-12-27",
            "end_date": null,
            "active": true
        },
        {
            "prog_id": 11958,
            "price_list_type": "A",
            "price_list_code": "00009999",
            "description_it": "Listino sartoria 00009999",
            "description_en": "Tailor list 00009999",
            "description_es": "Tailor list 00009999",
            "currency": "EUR",
            "start_date": "2022-12-22",
            "end_date": null,
            "active": true
        }
    ],
    "nextCursor": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTB2"
}

Get price lists by type

Retrieve Price Lists by Type

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get price lists by type

Retrieve Price Lists by Type#

Languages#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve Price Lists by Type

Languages

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js