Update supplier

Updating A Supplier

This API allows updating the supplier's details by specifying the SUBJECT_CODE. It accepts a PATCH request with the new supplier information and updates the existing record accordingly. A successful update returns the updated supplier details, while an error will be returned if the supplier is not found.

Once registered, this supplier can be subsequently utilized in the Insert product or the Update product for associating products.

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Languages

The API supports multilingual descriptions for the supplier's information, which can include description_it, description_en, etc. The JSON sample is given in English.

Preconditions

The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

The API client must provide a valid SUBJECT_CODE in the request path to identify the supplier.

The client must send the correct JSON payload with the updated supplier details.

Main Success Scenario

The API client sends a PATCH request with the SUBJECT_CODE and the updated supplier data.

The 4ws.suite Platform processes the request and updates the supplier data.

The platform returns the updated supplier details, including the prog_id and subject_code.

Alternate Flows

Supplier Not Found: If the SUBJECT_CODE does not match any supplier in the system, the API will return an error with a message like "Supplier not found with subject_code: {{subject_code}}".

Invalid Data: If the provided data is invalid or missing required fields, an error response will be returned.

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 to update the supplier data using the API:

Request

Path Params

Header Params

Body Params application/json

Example

{
    "supplier_company_name": "{{supplier_company_name}}",
    "address": "{{address}}",
    "zip_code": "{{zip_code}}",
    "city": "{{city}}",
    "country": "{{country}}",
    "region": "{{region}}",
    "province": "{{province}}",
    "language": "{{language}}",
    "currency": "{{currency}}",
    "company_vat_code": "{{company_vat_code}}",
    "email": "{{email}}",
    "phone": "{{phone}}",
    "website": "{{website}}",
    "invoice_address": "{{invoice_address}}",
    "invoice_zip_code": "{{invoice_zip_code}}",
    "invoice_city": "{{invoice_city}}",
    "invoice_country": "{{invoice_country}}",
    "invoice_region": "{{invoice_region}}",
    "invoice_province": "{{invoice_province}}",
    "invoice_subject_company_name": "{{invoice_subject_company_name}}",
    "payment_code": "{{payment_code}}",
    "barcode": "{{barcode}}",
    "note": "{{note}}"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Updating A Supplier#

Actors#

Languages#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Updating A Supplier

Actors

Languages

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js