Products

class py_veeqo.endpoints.products.Products(api_key: str | None = None)

Bases: PyVeeqo

This class implements all the products api calls.

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

Create a new product by passing information in either data or json format. https://developers.veeqo.com/docs#/reference/products/product-collection/create-a-new-product

Parameters:

  • data (Dict, optional) – Product data in dict format.

  • None. (Defaults to) –

  • json (Optional[JSONType], optional) – Product data in json format.

  • None. –

Returns:

Result object containing status code, message and data.

Return type:

Result

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

Create a new property by passing information in either data or json format. https://developers.veeqo.com/docs#/reference/products/create-properties/create-a-new-property

Parameters:

  • data (Dict, optional) – Product data in dict format.

  • None. (Defaults to) –

  • json (Optional[JSONType], optional) – Product data in json format.

  • None. –

Returns:

Result object containing status code, message and data.

Return type:

Result

delete_product(product_id: int) → Result

Delete a product by specifying it’s unique Veeqo identifier. https://developers.veeqo.com/docs#/reference/products/product/delete

Parameters:

product_id (int) – Unique Veeqo product identifier.

Returns:

Result object containing status code, message and data.

Return type:

Result

delete_product_property(product_id: int, property_id: int) → Result

Delete a product by specifying it’s unique Veeqo identifier.

Parameters:

  • product_id (int) – Unique Veeqo product identifier.

  • property_id (int) – Unique Veeqo property identifier.

Returns:

Result object containing status code, message and data.

Return type:

Result

get_all_products(since_id: int = None, warehouse_id: int = None, created_at_min: str = None, updated_at_min: str = None, page_size: int = 12, page: int = 1, query: str = None) → Result

Get a list of all products in inventory, and their corresponding information. https://developers.veeqo.com/docs#/reference/products/product-collection/list-all-products

Parameters:

  • since_id (int, optional) – Get products since a specific id.

  • None. (date. Defaults to) –

  • warehouse_id (int, optional) – Get products from a specific warehouse.

  • None. –

  • created_at_min (str, optional) – Get products created after a specific

  • None. –

  • updated_at_min (str, optional) – Get products updated after a specific

  • None. –

  • page_size (int, optional) – Number of products to return per page.

  • 12. (Defaults to) –

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

  • query (str, optional) – Search query to filter products. Defaults to None.

get_product_detail(product_id: int) → Result

Get product details for a specified product id. https://developers.veeqo.com/docs#/reference/products/product/view-product-detail

Parameters:

  • product_id (str) – Unique Veeqo id number for a given product.

  • SKU. (NOT to be confused with product) –

Returns:

All information on the specified product.

Return type:

Dict

get_product_properties(product_id: int, property_id: str) → Result

Get information about a specific property for a specific product. https://developers.veeqo.com/docs#/reference/products/product-properties/view-properties

Parameters:

  • product_id (str) – Specific product id to query.

  • property_id (str) – Specific property id for that product.

Returns:

All information on the property for that product.

Return type:

Dict

update_product_detail(product_id: int, data: Dict = None) → Result

Update the details of a product, specified by it’s unique Veeqo identifier. https://developers.veeqo.com/docs#/reference/products/product/update-product-detail

Parameters:

  • product_id (int) – Veeqo unique product identifier.

  • data (Dict, optional) – Product data in dict format.

  • None. (Defaults to) –

Returns:

Result object containing status code, message and data.

Return type:

Result

update_property_detail(product_id: int, property_id: int, data: Dict = None) → Result

Update the details of a product, specified by it’s unique Veeqo identifier. https://developers.veeqo.com/docs#/reference/products/product-properties/update-property-detail

Parameters:

  • product_id (int) – Veeqo unique product identifier.

  • property_id (int) – Veeqo unique property identifier.

  • data (Dict, optional) – Product data in dict format.

  • None. (Defaults to) –

Returns:

Result object containing status code, message and data.

Return type:

Result