Get price list

Retrieve Specific Price List by Type and Code

This API allows external systems to retrieve detailed information about a specific price list by specifying its type (PRICELIST_TYPE) and unique code (PRICELIST_CODE). Supported types include Sales (V), Purchase (A), and Invoice (F) price lists.

The purpose of this API is to allow external systems to retrieve information about a specific price list by its type and unique code. This can be useful for systems needing accurate, up-to-date pricing information associated with a specific list.

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

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 document creation service, please refer to Authentication.

Both PRICELIST_TYPE and PRICELIST_CODE are required parameters.

Main Success Scenario

The external system sends a GET request with PRICELIST_TYPE and PRICELIST_CODE in the endpoint path.

The API server processes the request, retrieves the corresponding price list, and returns the detailed data for the specified list.

Alternate Flows

If the specified PRICELIST_TYPE or PRICELIST_CODE does not exist, the API returns an error.

If either parameter is missing or incorrect, the API returns an error indicating an invalid request.

JSON Sample

{
    "price_list": {
        "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",
        "description_fr": "Tailor list 00008888",
        "description_de": "Tailor list 00008888",
        "description_ja": "Tailor list 00008888",
        "description_pt": "Tailor list 00008888",
        "description_ru": "Tailor list 00008888",
        "description_zh": "Tailor list 00008888",
        "description_ar": "Tailor list 00008888",
        "currency": "EUR",
        "start_date": "2022-12-27",
        "end_date": null,
        "active": true
    }
}

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_list":{"prog_id":6753,"price_list_type":"V","price_list_code":"100","description_it":"100","description_en":"100","description_es":"100","description_fr":"100","description_de":"100","description_ja":"100","description_pt":"100","description_ru":"100","description_zh":"100","description_ar":"100","currency":"EUR","start_date":"1990-01-01","end_date":"2999-12-12","active":true}}

🟠404Record Not Found

Retrieve Specific Price List by Type and Code

Actors

Preconditions

Main Success Scenario

Alternate Flows

JSON Sample

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get price list

Retrieve Specific Price List by Type and Code#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

JSON Sample#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve Specific Price List by Type and Code

Actors

Preconditions

Main Success Scenario

Alternate Flows

JSON Sample

Sequence Diagram

Code Examples in Node.js