Get entities from price lists

Retrieve Entities in a Specific Price List

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

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 (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, PRICELIST_CODE.
If the request is successful, the system will return an HTTP 200 response with the paginated list of entities linked to the specified price list and a nextCursor indicating whether there are more entities linked to the specified price list 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 in Mermaid

Code Examples in Node.js

Responses

🟢200OK

application/json

Body

Example

{
    "entities": [
        {
            "prog_id": 4121,
            "entity_code": "8888"
        },
        {
            "prog_id": 4122,
            "entity_code": "9999"
        }
    ],
    "nextCursor": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTB2"
}

🟠404Pricelist Not Found

Get entities from price lists

Retrieve Entities in a Specific Price List

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram in Mermaid

Code Examples in Node.js

Request

Request Code Samples

Responses

Get entities from price lists

Retrieve Entities in a Specific Price List#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram in Mermaid#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve Entities in a Specific Price List

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram in Mermaid

Code Examples in Node.js