getInventorySuppliers
The method allows you to retrieve a list of suppliers available in BaseLinker storage.
Input parameters
Output data:
A sample request in PHP:
| filter_id | int | (optional) Limiting results to a specific supplier ID |
| filter_name | varchar(40) | (optional) Filtering by supplier name (full or partial match) |
Output data
The method returns the data in JSON format.
| status | varchar(30) | SUCCESS - request executed correctly ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code |
| suppliers | array | List of suppliers. Each element contains fields listed below |
| | - supplier_id | int | Supplier identifier |
| | - name | varchar(40) | Supplier name |
| | - address | varchar(200) | (optional) Supplier address |
| | - postcode | varchar(20) | (optional) Supplier postal code |
| | - city | varchar(80) | (optional) Supplier city |
| | - phone | varchar(40) | (optional) Supplier phone number |
| varchar(200) | (optional) Supplier email address | |
| | - email_copy_to | varchar(200) | (optional) Additional email addresses for correspondence |
| | - currency | varchar(3) | (optional) Default supplier currency (e.g. EUR, USD) |
Sample
Input data:Output data:
A sample request in PHP: