Suppliers [API]
The suppliers GET request allows you to view all your existing suppliers along with their parameters.
Notes:
| Description | List available Suppliers
|
| Action | GET |
| URL | <your URL here>/api/suppliers |
| Sample Request Parameters
|
(empty – no data required) |
| Sample Successful Response
|
[
{
"id": 1,
"email": "supplier@b2bwave.com",
"created_at": "2021-02-16T15:23:38.000+02:00",
"updated_at": "2025-12-03T16:14:12.000+02:00",
"name": "Supplier Name",
"company_name": "SUPPLIER",
"is_active": true,
"order_min_amount": "0.0",
"locale": "en",
"permissions": {
"can_send_order_messages": true,
"can_access_inventory_control_report": true,
"can_access_customers_performance_report": true,
"can_access_product_sales_report": true,
"can_access_orders_summary_report": true
}
}
]
|
Field descriptions
| Name | Type | Description |
| id | integer | Supplier identifier
|
| string | Supplier email
|
|
| name | string | Supplier name
|
| company_name | string | Supplier company name |
| is_active | boolean | Specifies if the supplier is active or has been deactivated
|
| created_at | datetime | Datetime this supplier was created
|
| updated_at | datetime | Most recent datetime this supplier was modified
|
| order_min_amount
|
decimal | The minimum amount to order from a specific supplier (default 0.0)
|
| locale | string
|
The language locale of the supplier
|
| permissions
|
object | Various permissions that can also be edited from the web interface
|
|
|