Warehouses

class py_veeqo.endpoints.warehouses.Warehouses(api_key: str | None = None)

Bases: PyVeeqo

This class implements all the warehouses api calls.

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

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

Parameters:

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

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

delete_warehouse(warehouse_id: int) → Result

Delete a specific warehouse. https://developers.veeqo.com/docs#/reference/warehouses/warehouse/delete

Parameters:

warehouse_id (int) – The id of the warehouse.

get_all_warehouses(page_size: int = 12, page: int = 1, external_id: str = None) → Result

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

Parameters:

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

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

update_warehouse_detail(warehouse_id: int, data: Dict = None) → Result

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

Parameters:

  • warehouse_id (int) – The id of the warehouse.

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

view_warehouse_detail(warehouse_id: int) → Result

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

Parameters:

warehouse_id (int) – The id of the warehouse.