Delete all product prices

Remove Product Prices From a List

This API allows removing all prices for a specific product from a price list. The request requires specifying the PRICE_LIST_TYPE (type of price list), PRICE_LIST_CODE (price list code), and the ITEM_CODE (product code).

Product Pricing

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.

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

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

Main Success Scenario

The API client sends a DELETE request with the PRICE_LIST_TYPE, PRICE_LIST_CODE, and ITEM_CODE.

If the request is successful, the system will return a success message indicating that all prices for the product were removed from the price list.

Move a product to a list

If you want to move a product from one price list to another, it may be useful to unhook it before proceeding:

retrieve the historical prices of a product Get prices

unhook the product Delete product

add the product with its prices to the desired list Insert price

`remove_first_prices` Parameter

The API allows for the removal of all prices associated with a product.
However, the price dated 1900-12-31, which is considered the product’s first price used in warehouse documents, can only be deleted if explicitly requested.

This price is automatically created when the first price of the product is added, whether through the Insert Product Price, bulk CSV upload, or the suite's user interface.
The API accepts an optional boolean parameter remove_first_prices: if set to true, it also removes the price dated 1900-12-31; if set to false, it removes all prices except the one dated 1900-12-31, ensuring correct warehouse movement management.

Alternate Flows

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

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

Product Not Found: If the specified ITEM_CODE does not exist, the API will return 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 removing all prices for a product from a price list:

Delete all product prices

Remove Product Prices From a List

Actors

Preconditions

Main Success Scenario

`remove_first_prices` Parameter

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Delete all product prices

Remove Product Prices From a List#

Actors#

Preconditions#

Main Success Scenario#

remove_first_prices Parameter#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Remove Product Prices From a List

Actors

Preconditions

Main Success Scenario

`remove_first_prices` Parameter

Alternate Flows

Sequence Diagram

Code Examples in Node.js