Update item supplier

Updating Supplier Association with Products

This API allows an external system to update the association of a supplier with products in the inventory. Specifically, it can modify whether the supplier is designated as the main supplier for a given product.

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 PATCH request to update whether the supplier is the main supplier for the product specified in the {ITEM_CODE}.

If no other supplier is marked as the primary supplier, the update will be successful, and the supplier will be associated with the product accordingly.

Successful Response:

{
  "prog_id": 178175,
  "subject_code": "EXA01SUPP",
  "item_code": "xxxxx",
  "success": true
}

Alternate Flows

Primary Supplier Already Exists: If a primary supplier is already assigned to the product, the API returns an error (HTTP 403). The response includes the supplier code of the current primary supplier:

{
  "message": "The supplier with code {supplier_code} is already associated as the primary supplier for the product.",
  "supplier_code": "{supplier_code}"
}

To resolve this, the external system must first deactivate the current primary supplier before making the new assignment.

Invalid Supplier Code:

If the supplier_code provided does not exist or is invalid, the API will return an error (HTTP 422).

Missing Product:

If the ITEM_CODE does not exist in the system, the API will return an error (HTTP 422) indicating the product was not found.

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 Example in Node.js

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

This script updates the supplier for a product, marking it as the primary supplier if main is set to true. If an error occurs, it handles the 403 response and logs the appropriate message.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200POST/PATCH/DELETE Errore record non trovato

application/json

Body

Examples

SuccessSuccess

{
    "prog_id": 178175,
    "subject_code": "EXA01SUPP",
    "item_code": "xxxxx",
    "success": true
}

🟠401Authentication failed

🟠403Operation not allowed

🟠422Product not found

🟠422Supplier code not found

🟠403Main supplier exists

Update item supplier

Updating Supplier Association with Products#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Callback Response#

Sequence Diagram#

Code Example in Node.js#

Request

Request Code Samples

Responses

Updating Supplier Association with Products

Actors

Preconditions

Main Success Scenario

Alternate Flows

Callback Response

Sequence Diagram

Code Example in Node.js