Get A Specific Supplier

Retrive a Supplier

This API allows the retrieval of the supplier details by specifying the SUBJECT_CODE. The response includes various details about the supplier, such as company name, address, contact information, and invoice data.

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 API client must provide a valid SUBJECT_CODE in the request path.

The client must have proper authorization to access supplier data.

Main Success Scenario

The API client sends a GET request with the SUBJECT_CODE to retrieve the supplier details.

The 4ws.suite Platform processes the request and returns the supplier data, including various fields such as the company name, address, and VAT code.

The response contains the details of the supplier.

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

Invalid SUBJECT_CODE Format: If the SUBJECT_CODE format is incorrect, the API will return an error indicating the invalid input.

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

Responses

🟢200POST/PATCH/DELETE Errore record non trovato

application/json

Body

Example

{
    "supplier": {
        "supplier_code": "54",
        "supplier_company_name": "Brenda Ankunding",
        "address1": "Wales Pfefferbury Clwyd 821 Giovanna Mead Apt. 290",
        "address2": "Wales Jacobi-over-Russel Strathclyde 43 Roscoe Brae Apt. 791",
        "zip_code": "TH9 8BA",
        "city": "Long Zemlak",
        "country": "Saint Lucia",
        "region": null,
        "province": "England",
        "language": "laboris quis in",
        "currency": "QAR",
        "company_vat_code": "24",
        "payment_code": "63",
        "barcode": "9",
        "note_it": "Lorem esse eu mollit",
        "note_en": "magna quis",
        "note_de": "aliqua",
        "note_es": "ullamco aute",
        "note_fr": null,
        "note_pt": null,
        "note_ru": null,
        "note_ar": null,
        "note_ja": "Excepteur cillum nostrud commodo nulla",
        "note_zh": null,
        "courier": null
    }
}

Get A Specific Supplier

Retrive a Supplier

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get A Specific Supplier

Retrive a Supplier#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrive a Supplier

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js