Suppliers

Suppliers Management

This section provides a comprehensive guide to managing the suppliers in our system. You will find options for retrieving supplier information, tailored to different requirements.

Supplier Retrieval

Get All Suppliers

  • Endpoint: /get_suppliers
  • Description: This endpoint is designed to retrieve the list of suppliers available in your database, providing a comprehensive overview of all suppliers without applying any filters.
  • Usage Notes:
    • Pagination: To manage data effectively, this endpoint supports fetching up to 50 suppliers at a time.
    • Parameters:
    • start - Specify the starting point (offset) of the row from which to begin fetching suppliers.
    • limit - Control the number of suppliers returned in a single request. The maximum limit is 50, but you can opt for a smaller number based on your needs.
    • Single Supplier: Pass supplier_id to retrieve a specific supplier by its ID (pagination is ignored).
    • Search: Pass search keyword to search across multiple supplier columns (name, phone, email, address, tax ID, etc.). Supports multi-word queries with AND logic.
    • Hidden Suppliers: Pass show_invisible=1 to include suppliers with visible=0 in the response.
    • Method: This functionality can be utilized by including payload or parameters in your POST request to manage the start, limit, and filter parameters.

These features are particularly useful for handling large datasets and for applications requiring batch processing of supplier information.



For further assistance or API integration support, please refer to our API Documentation or contact our technical support team.