Delete single product price

Remove A Single Product Price From a List

This API allows removing a single price 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 as URL params. Additionals filters can be set with query params

DELETE /priceLists/:PRICE_LIST_TYPE/:PRICE_LIST_CODE/prices/:ITEM_CODE?start_date=YYYY-MM-DD&dimension_grouping=GROUPING1

If the request is successful, the system will return a success message indicating that price for the product was 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 all product prices

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

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}}"
}

Price Not Found: If the specified price on the start_date does not exist, the API will return an error message:

{
  "message": "Product price not found with item_code: {{item_code}} and {{start_date}}"
}

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 a single price for a product from a price list:

Delete single product price

Remove A Single Product Price From a List

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Delete single product price

Remove A Single Product Price From a List#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Remove A Single Product Price From a List

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js