Update Product price

Update Product Prices

This API allows updating a product and its price to a specific price list by specifying the PRICE_LIST_TYPE (type of price list), PRICE_LIST_CODE (price list code), and ITEM_CODE (product code). The client need also to provide a start_date and price for the product.

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.

History of product prices

The suite allows you to manage the history of price changes for a product, each price has a start of validity and end of validity date.
A product considered a given document will have only one price per type (sale, purchase, invoice, etc...).

Valid start date passed

If you want to update a price for a product, you must specify the start_date you want to change and the system will update the price only if a price has been entered from the entered start_date.

Starting

The product MAGLIA1234 has a sales price of €19.99 valid starting from 20/05/2024.

Update price to €21.99

The product MAGLIA1234 will be update to €21.99 if the entered start date is 20/05/2024.

Document with movement date 05/15/2024

If a NEW document with movement date 20/05/2024 is registered, the price of the product will be €21.99, the product in the other documents with movement date 20/05/2024 will remain €19.99.

Prices by size range

It is possible to update prices to products managed with price range per size by valuing dimensiong_grupping with the range.

Specify the value BABY in the dimensiong_grupping field and the price in price.

{
    "start_date": "2024-05-06",
    "price": "150",
    "dimension_grouping": "BABY"
}

In this way all sizes in the range will assume that price starting from the start_date.

Preconditions

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

The PRICE_LIST_TYPE and PRICE_LIST_CODE must correspond to an existing price list in the system.

The ITEM_CODE provided must correspond to an existing product in the system.

Main Success Scenario

The API client sends a PATCH request with the PRICE_LIST_TYPE, PRICE_LIST_CODE, ITEM_CODE, start_date, and price.

If successful, the API returns a response with a success message.

Alternate Flows

Price List Not Found: If the specified PRICE_LIST_CODE does not exist, the API returns an error message:

{
  "message": "Price list not found"
}

Product Not Found: If the specified item_code does not exist, the API returns an error message:

{
  "message": "Product not found with item_code: {{item_code}}"
}

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 adding a product to a price list:

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Update Product price