Insert item supplier

New Supplier Association to a Product

This API can used by an external system for associates a new supplier with a product by invoking an API. The system sends a request to link a specific supplier to the given product, optionally marking the supplier 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 POST request to associate a supplier (supplier_code) with a product (ITEM_CODE).

If the supplier is successfully associated, the API returns a success response with the details of the association:

{
  "prog_id": 178175,
  "subject_code": "SUP001",
  "item_code": "ITEM001",
  "success": true
}

If the supplier is marked as the primary supplier (main: true) and no other primary supplier is associated, the supplier will be successfully marked as the main supplier.

The system processes the response and confirms the successful association.

Alternate Flows

Supplier Already Marked as Main:

If a supplier is already marked as the primary supplier, the API returns an error response:

{
  "message": "error"
}

In this case, the external system must first disassociate ìthe current primary supplier before associating a new primary supplier calling Update item supplier with same ITEM_CODE and this body

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 a 404 error 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 (Mermaid)

Best Practices

Please refer to Best Practices for Error Handling in External System for best practices on implementation.

Code Examples in Node.js

Here's an example of associating a supplier with a product using Node.js and Axios:

In this example, the associateSupplierWithProduct function handles both the successful association of a supplier and error scenarios, such as when a supplier is already marked as the main supplier.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Examples

SuccessSuccessSuccess

{
    "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 exits

Insert item supplier

New Supplier Association to a Product#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Callback Response#

Sequence Diagram (Mermaid)#

Code Examples in Node.js#

Request

Request Code Samples

Responses

New Supplier Association to a Product

Actors

Preconditions

Main Success Scenario

Alternate Flows

Callback Response

Sequence Diagram (Mermaid)

Code Examples in Node.js