Insert Price List

Insert New Price List

This API allows the creation of a new price list of a specified type. The price list type (PRICE_LIST_TYPE) is passed as a parameter to define the purpose of the list. Available types are:

V: Sales

A: Purchase

F: Invoice

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.

Languages

To support multilingual descriptions, JSON fields such as description_it, description_en, etc., can be used to provide translated descriptions.

Manage Languages

To understand how languages are managed, please refer to our Managing Languages Documentation.

Preconditions

The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

The PRICE_LIST_TYPE must be valid (V, A, or F).

The price_list_code should be unique in the system to avoid conflicts.

Main Success Scenario

The API client sends a POST request to create a new price list, specifying fields like price_list_code, description_it, start_date, end_date, currency, and active status.

If successful, the API returns a response that includes the internal ID (prog_id) and the price_list_code.

Alternate Flows

Duplicate Price List Code: If a price list with the same price_list_code already exists, the API returns an error message indicating a unique constraint violation.

{
  "message": "Unique constraint error"
}

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

Example Node.js code for creating a new price list:

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert New Price List#

Actors#

Languages#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Insert New Price List

Actors

Languages

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js