API documentation
Method list
Test your request
Changelog


getInventorySuppliers
The method allows you to retrieve a list of suppliers available in BaseLinker storage.


Input parameters
filter_idint(optional) Limiting results to a specific supplier ID
filter_namevarchar(40)(optional) Filtering by supplier name (full or partial match)



Output data
The method returns the data in JSON format.
statusvarchar(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
suppliersarrayList of suppliers. Each element contains fields listed below
| - supplier_idintSupplier identifier
| - namevarchar(40)Supplier name
| - addressvarchar(200)(optional) Supplier address
| - postcodevarchar(20)(optional) Supplier postal code
| - cityvarchar(80)(optional) Supplier city
| - phonevarchar(40)(optional) Supplier phone number
| - emailvarchar(200)(optional) Supplier email address
| - email_copy_tovarchar(200)(optional) Additional email addresses for correspondence
| - currencyvarchar(3)(optional) Default supplier currency (e.g. EUR, USD)



Sample
Input data:
Output data:
A sample request in PHP: