Get Item suppliers

Retrieving Items Supplier

The external system needs to retrieve items supplier details that are registered in the 4ws.trade system.
It can either fetch all suppliers in a paginated format or query details of a specific supplier by providing the supplier_code. The system will return the relevant information in a structured format.

The API supports pagination to navigate through large lists of items supplier.

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

If the request is successful, the system will return an HTTP 200 response with the paginated list of items supplier and a nextCursor indicating whether there are more items supplier to retrieve. If nextCursor is setted, the external system must be call again, this service, setting cursor as nextCursor value.

Response Example

Retrieve all Suppliers

You can retrieve all product suppliers by querying this service. In this case, only the supplier code is not setted.

The response will include all suppliers product.

Retrieve a specific Supplier

If for example you want to retrieve only the supplier with code 1232.

The response will include only the supplier specified on SUPPLIER_CODE parameter.

Alternate Flows

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

Authentication Error Example

Invalid Supplier Code: If the provided SUPPLIER_CODE does not match any supplier in the system, the response will be:

Invalid Supplier Code 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 Product

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

Case 1: Retrieving All Suppliers

Case 2: Retrieving a Specific Supplier

Responses

🟢200GET Success

application/json

Body

Example

{
    "item_code": "consequat",
    "suppliers": [
        {
            "supplier_code": "sed amet",
            "main": false
        }
    ],
    "nextCursor": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTB2"
}

🟠422Invalid pageSize

🟠401Authentication failed

🟠403Operation not allowed

🟠404Product not found with item_code

Get Item suppliers

Retrieving Items Supplier

Actors

Preconditions

Main Success Scenario

Retrieve all Suppliers

Retrieve a specific Supplier

Alternate Flows

Sequence Diagram

Case 1: Retrieving All Suppliers Product

Case 2: Retrieving a Specific Supplier

Code Examples in Node.js

Case 1: Retrieving All Suppliers

Case 2: Retrieving a Specific Supplier

Request

Request Code Samples

Responses

Get Item suppliers

Retrieving Items Supplier#

Actors#

Preconditions#

Main Success Scenario#

Retrieve all Suppliers#

Retrieve a specific Supplier#

Alternate Flows#

Sequence Diagram#

Case 1: Retrieving All Suppliers Product#

Case 2: Retrieving a Specific Supplier#

Code Examples in Node.js#

Case 1: Retrieving All Suppliers#

Case 2: Retrieving a Specific Supplier#

Request

Request Code Samples

Responses

Retrieving Items Supplier

Actors

Preconditions

Main Success Scenario

Retrieve all Suppliers

Retrieve a specific Supplier

Alternate Flows

Sequence Diagram

Case 1: Retrieving All Suppliers Product

Case 2: Retrieving a Specific Supplier

Code Examples in Node.js

Case 1: Retrieving All Suppliers

Case 2: Retrieving a Specific Supplier