Delete item supplier

Removing Supplier Association with Products

This API allows an external system to remove the association between a product and a supplier. The supplier associated with a given product can be deleted unless it is the primary supplier. If the supplier is marked as the primary supplier, it cannot be removed until it is deactivated as the primary supplier.

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.

Main Success Scenario

The external system sends a DELETE request to remove the supplier with code {SUPPLIER_CODE} from the product with code {ITEM_CODE}.

If the supplier is not marked as the primary supplier, the system successfully removes the association.

Successful Response:

{
  "success": true
}

Alternate Flows

Attempt to Delete Primary Supplier: If the supplier is marked as the primary supplier, the API returns an error indicating that the supplier cannot be removed until it is deactivated as the primary supplier. The external system should update the supplier using the PATCH API Update item supplier to deactivate it as the primary supplier, then proceed with deletion.

{
  "message": "Cannot delete primary supplier. Deactivate the supplier as primary before removal."
}

Supplier Does Not Exist: If the supplier is not associated with the product or the supplier code is invalid, the API returns an error indicating that no association exists:

{
  "message": "Supplier association not found."
}

Validation Errors: If there is a problem with the input, such as an invalid supplier or product code, the API returns a 422 Unprocessable Entity error:

{
  "message": "Invalid request."
}

Callback Response

This API does not involve callbacks. The response is returned immediately after the API call is processed.

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

Here is an example of how to remove a supplier association for a product in Node.js:

This script attempts to remove the supplier association for the product, handling both success and error responses accordingly.

Delete item supplier

Removing Supplier Association with Products

Actors

Preconditions

Main Success Scenario

Alternate Flows

Callback Response

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Delete item supplier

Removing Supplier Association with Products#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Callback Response#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Removing Supplier Association with Products

Actors

Preconditions

Main Success Scenario

Alternate Flows

Callback Response

Sequence Diagram

Code Examples in Node.js