Suppliers

class py_veeqo.endpoints.suppliers.Suppliers(api_key: str | None = None)

Bases: PyVeeqo

This class implements all the suppliers api calls.

create_new_supplier(data: Dict = None, json: Dict[str, Any] | List[Any] | str | int | float | bool | None = None) → Result

Create a new supplier. https://developers.veeqo.com/docs#/reference/suppliers/supplier-collection/create-a-new-supplier

Parameters:

  • data (Dict, optional) – Supplier data. Defaults to None.

  • json (Optional[JSONType], optional) – Supplier data. Defaults to None.

delete_supplier(supplier_id: int) → Result

Delete a specific supplier. https://developers.veeqo.com/docs#/reference/suppliers/supplier/delete

Parameters:

supplier_id (int) – Supplier id.

list_all_suppliers(page_size: int = 12, page: int = 1) → Result

Get a list of all suppliers. https://developers.veeqo.com/docs#/reference/suppliers/supplier-collection/list-all-suppliers

Parameters:

  • page_size (int, optional) – Number of suppliers per page. Defaults to 12.

  • page (int, optional) – Page number. Defaults to 1.

update_supplier_detail(supplier_id: int, data: Dict = None) → Result

Update details of a specific supplier. https://developers.veeqo.com/docs#/reference/suppliers/supplier/update-supplier-detail

Parameters:

  • supplier_id (int) – Supplier id.

  • data (Dict, optional) – Supplier data. Defaults to None

view_supplier_detail(supplier_id: int) → Result

Get details of a specific supplier. https://developers.veeqo.com/docs#/reference/suppliers/supplier/view-a-supplier-detail

Parameters:

supplier_id (int) – Supplier id.