products

List products in a hub for user search

Endpoint to retrieve products based on the passed string and hub ID.

Args: hub_id (int): Hub identifier. product_name: Product name to filter by. Defaults to Query(..., min_length=1, description="Search text"). subcategory_id: Subcategory ID to filter by. params (Params, optional): Pagination parameters. Defaults to Depends(). session (AsyncSession, optional): Database session. Defaults to Depends(async_get_session). product_controller (ProductController, optional): Product controller instance. Defaults to Depends(get_product_controller). hub_controller (HubController, optional): Hub controller instance. Defaults to Depends(get_hub_controller). user (User, optional): Authenticated user. Defaults to Depends(try_get_user_by_firebase_user).

Returns: List[ProductRetrieveSchema]: contains the products retrieved for the given hub_id and product_name, formatted according to the ProductRetrieveSchema Pydantic model

get/hubs/{hub_id}/products

Request

  • Base URL: https://api.venhub.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.venhub.com/hubs/{hub_id}/products
  • Auth: none declared

Path parameters

hub_idinteger required

Query parameters

subcategory_idinteger nullable

Filter by subcategory

category_idinteger nullable

Filter by category

product_namestring nullable

Search text

pageinteger
sizeinteger

Response

Successful Response

namestring required
image_urlstring nullable required
upcstring nullable required
original_priceinteger required
discounted_priceinteger nullable
quantity_in_stockinteger required
max_per_orderinteger required
subcategory_idinteger required
category_idinteger required
hub_idinteger required
is_favoriteboolean required
idinteger required
descriptionstring nullable
subcategorystring required
categorystring required
quantity_in_basketinteger required
tax_type'sales_tax' | 'bottle_tax' | 'no_tax' | 'unknown_tax' required
typestring nullable
nutritionobject nullable
tax_codestring nullable
deal_idsinteger[]

Changes

No recorded changes to this operation across all 1 revision of this API.