4WS Suite
Home
API Reference
  • Data mangement API
  • Documents API
Home
API Reference
  • Data mangement API
  • Documents API
Fourwayshop
  1. Price lists
  • Login
    • login
      POST
  • Product
    • Brand
      • Get All Brands
      • Get A Brand
      • Insert brand
      • Update brand
    • Season
      • Get All Seasons
      • Get A Season
      • Insert season
      • Update season
    • Attribute
      • Get All Attribute Types
      • Get Attribute Type
      • Get Attribute
      • Insert attribute
      • Update attribute
    • Hierarchy
      • Insert hierarchy
      • Update hierarchy
    • Dimension groups
      • Insert dimension group
      • Update dimension group
    • Dimension
      • Insert dimension
      • Update dimension
      • Delete dimension
    • Product
      • Get products
      • Get product
      • Get product grouping
      • Get SKU's barcodes
      • Get product stock
      • Insert product
      • Update product
    • Activate dimensions on products
      • Insert active dimensions
      • Delete active dimensions
    • Barcode
      • Get SKU from barcode
      • Generate missing barcodes
      • Generate missing barcode for SKU
      • Insert barcode
      • Delete barcode
    • Prices
      • Get product prices
    • Price dimension groupings
      • Get Dimension Price Grouping
      • Get All Dimension Price Grouping
      • Insert dimension grouping
      • Update dimension grouping
      • Delete dimension grouping
    • Assortment
      • insert product assortment
      • delete product assortment
    • Image
      • Get images
      • Add image
      • Replace image
      • Delete image
    • Supplier
      • Get Item suppliers
      • Insert item supplier
      • Delete item supplier
      • Update item supplier
    • Custom category
      • Get Custom code
      • Insert Custom code
      • Update Custom code
    • Vat
      • Vat types
        • Get VAT type
        • Get VAT types
      • VATs
        • Get VATs
        • Get VATs by type
        • Get VAT
      • Vat rates
        • Get VAT rates
        • Get single VAT rates
    • Stock
      • Insert stock
      • Get stock
  • Price lists
    • Get price lists
      GET
    • Get price lists by type
      GET
    • Get price list
      GET
    • Get prices from price list
      GET
    • Get entities from price lists
      GET
    • Insert Price List
      POST
    • Insert Product Price
      POST
    • Insert Entity On Price Lists
      POST
    • Update price list
      PATCH
    • Delete all product prices
      DELETE
    • Delete single product price
      DELETE
    • Delete entity from a price lists
      DELETE
  • Supplier
    • Supplier contacts
    • Supplier addresses
    • Get Suppliers
    • Get A Specific Supplier
    • Insert supplier
    • Update supplier
  • Entities
    • Get entities
    • Get entity
    • Insert entity
    • Update entity
  • Miscellaneous
    • Get requests rate limits
  • Catalog
    • Get Catalogs details
    • Get Catalog details by Code
    • Get products by Catalog Code
  • Export
    • Get bulk CSV Export
  1. Price lists

Insert Price List

POST
/api/v1/pricelists/{PRICE_LIST_TYPE}
Last modified:2025-02-07 15:01:29

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#

1.
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.
2.
If successful, the API returns a response that includes the internal ID (prog_id) and the price_list_code.

Alternate Flows#

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

Path Params

Body Params application/json

Example
{
    "priceList": "LIST_1001",
    "priceListType": "SALE",
    "description": "Test api",
    "startDate": "2021-01-01",
    "endDate": "2021-01-02",
    "currency": "EUR",
    "active": "T"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/pricelists/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "priceList": "LIST_1001",
    "priceListType": "SALE",
    "description": "Test api",
    "startDate": "2021-01-01",
    "endDate": "2021-01-02",
    "currency": "EUR",
    "active": "T"
}'

Responses

🟢200Success
application/json
Body

Example
{
    "price_list": {
        "prog_id": 192477,
        "price_list_code": "9999"
    }
}
🟠422Unique constraint error
🟠401Authentication failed
🟠403Operation not allowed
Modified at 2025-02-07 15:01:29
Previous
Get entities from price lists
Next
Insert Product Price
Built with