Delete entity from a price lists

Remove an Entity From A Price List

This API allows removing an entity (specified by ENTITY_CODE) from a specific price list. The request requires specifying the PRICE_LIST_TYPE (the type of price list), PRICE_LIST_CODE (the code of the price list), and ENTITY_CODE (the code of the entity to be removed).

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 ENTITY_CODE must be valid and associated with the given price list.

Main Success Scenario

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

If the entity exists and is associated with the price list, the system successfully removes the entity from the list.

The API responds with a success message.

INFO

To get the list of locations you can query the suite with the service Get entities

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

Invalid Entity Code: If the ENTITY_CODE is not valid or cannot be found, the API will return an error message indicating invalid input:

{
  "message": "Invalid input",
  "errors": [
    {
      "msg": "value '2340888' is not valid for field entity_code",
      "param": "entity_code",
      "location": "params"
    }
  ]
}

Entity Not Associated to the Price List: If the entity exists but is not associated with the specified price list, the API will return the following message:

{
  "message": "Entity not associated to the pricelist"
}

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 an entity from a price list:

Delete entity from a price lists

Remove an Entity From A Price List

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Delete entity from a price lists

Remove an Entity From A Price List#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Remove an Entity From A Price List

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js