Get Suppliers

Retrieve All Suppliers

This API allows the retrieval of supplier data, paginated to improve performance when dealing with large sets of data. The request includes parameters for pagination, such as page and pageSize, and will return a list of suppliers with details like company name, address, and contact information. The external system must continue to call the API with updated page numbers until the moreRows flag in the response is false, indicating there are no more suppliers to retrieve.

The API supports pagination to navigate through large lists of suppliers.

Paginated Responses

The service is paginated to handle large sets of data efficiently.
For detailed information on how to handle pagination, refer to our Paginated Responses

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 service, please refer to Authentication.

Pagination parameters cursor and nextCursor must be correctly configured in the request.

Main Success Scenario

Case 1: Retrieving All Suppliers

If the SUPPLIER_CODE parameter is not provided, the API will return all suppliers in a paginated format. nextCursor indicating whether there are more suppliers to retrieve. If nextCursor is setted, the external system must be call again, this service, setting cursor as nextCursor value.

Example request:

Response Example

The nextCursor field indicates if there are more suppliers to be retrieved in the next pages, please refer to Paginated Responses how to manage next pages.

Case 2: Retrieving a Specific Supplier

If the SUPPLIER_CODE parameter is provided, the API will return the specific supplier that matches the provided code. The result is a single supplier object without nextCursor field.

Alternate Flows

Authentication Error: If the client does not provide valid credentials, an error response is returned.

Error Example

Empty Result: If no collections exist, the suppliers array will be empty.

Cursor & PageSize Used Together: Cursor and PageSize parameters in the request: If you specify a Cursor you cannot specify the page size. This information will already be contained within the cursor.

Error Example

Pagination Error: If invalid cursor parameters are provided, an error response is returned.

Rate Limiting: If the API rate limits are exceeded, the client must respect the retry interval indicated in the response headers Rate Limits.

Sequence Diagram

Case 1: Retrieving All Suppliers

Case 2: Retrieving a Specific Supplier

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 for retrieving suppliers from the API, handling pagination:

Responses

🟢200POST/PATCH/DELETE Errore record non trovato

application/json

Body

Example

{
    "suppliers": [
        {
            "supplier_code": "5",
            "supplier_company_name": "Marianne Beatty",
            "address1": "England O'Conner End Buckinghamshire 5 Borer Ridge Apt. 224",
            "address2": "England Upper Boyle Cross County Tyrone 354 Gutkowski Green Suite 928",
            "zip_code": "ZS6 2LU",
            "city": "McLaughlinley",
            "country": "Belize",
            "region": "cupidatat consectetur do non",
            "province": "Scotland",
            "language": null,
            "currency": "GYD",
            "company_vat_code": "5",
            "payment_code": "30",
            "barcode": "39",
            "note_it": "aliqua commodo laboris culpa nostrud",
            "note_en": null,
            "note_de": "quis esse Excepteur",
            "note_es": "est",
            "note_fr": "esse",
            "note_pt": null,
            "note_ru": null,
            "note_ar": "nisi aute id do dolor",
            "note_ja": null,
            "note_zh": "fugiat laborum",
            "courier": null
        },
        {
            "supplier_code": "66",
            "supplier_company_name": "Andre Torphy",
            "address1": "England South Sporerwell Somerset 52 Halvorson Street Suite 280",
            "address2": "Northern Ireland Little Botsford Cross Hertfordshire 33 Albert Road Suite 728",
            "zip_code": "AY1 0NS",
            "city": "Kuhichampton",
            "country": "Aland Islands",
            "region": "ea aliquip magna",
            "province": "Scotland",
            "language": null,
            "currency": "CRC",
            "company_vat_code": "24",
            "payment_code": "51",
            "barcode": "55",
            "note_it": "consectetur in adipisicing eiusmod",
            "note_en": "veniam consequat consectetur",
            "note_de": "amet irure quis",
            "note_es": "consectetur",
            "note_fr": null,
            "note_pt": "labore Lorem ut sed",
            "note_ru": "sint",
            "note_ar": null,
            "note_ja": null,
            "note_zh": null,
            "courier": "magna esse cupidatat Duis"
        }
    ],
    "nextCursor": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTB2"
}

Retrieve All Suppliers

Actors

Preconditions

Main Success Scenario

Case 1: Retrieving All Suppliers

Case 2: Retrieving a Specific Supplier

Alternate Flows

Sequence Diagram

Case 1: Retrieving All Suppliers

Case 2: Retrieving a Specific Supplier

Code Examples in Node.js

Request

Request Code Samples

Responses

Get Suppliers

Retrieve All Suppliers#

Actors#

Preconditions#

Main Success Scenario#

Case 1: Retrieving All Suppliers#

Case 2: Retrieving a Specific Supplier#

Alternate Flows#

Sequence Diagram#

Case 1: Retrieving All Suppliers#

Case 2: Retrieving a Specific Supplier#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Retrieve All Suppliers

Actors

Preconditions

Main Success Scenario

Case 1: Retrieving All Suppliers

Case 2: Retrieving a Specific Supplier

Alternate Flows

Sequence Diagram

Case 1: Retrieving All Suppliers

Case 2: Retrieving a Specific Supplier

Code Examples in Node.js