GET /suppliers

Status codes

• 200 on success

Response properties

• list: The array of Supplier objects.

There is no pagination for Suppliers, the result will always contain all the available suppliers for the account.

You can see all the Supplier properties on the GET /suppliers/:id page under "Response properties".

Example response

{
  "list": [
    {
      "id": 1655819191963,
      "name": "Test Supplier",
      "email": "test-supplier@yourbarmate.com",
      "connect": false,
      "customer_id": "cus_123456",
      "phone": "076 7798775",
      "last_delivery": 1695113842637,
      "min_order_amount": 200000
    },
    {
      "id": 1655819192441,
      "name": "The Connect Supplier",
      "email": "connect-orders@yourbarmate.com",
      "connect": true,
      "customer_id": "cus_789abc",
      "last_delivery": 1695114900700,
      "preferred_delivery_days": {
        "2": {
          "enabled": true
        },
        "5": {
          "enabled": false,
          "time": "17:00"
        }
      }
    },
    {
      "id": 1663253696138,
      "name": "The Other Supplier",
      "email": "test2-supplier@yourbarmate.com",
      "connect": false,
      "archived": 1681392409254,
      "phone": "076 7798775",
      "last_delivery": 1695114958819
    }
  ]
}