> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vellaro.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Products

> Public paginated product listing with filters.

Every filter is one predicate shared by the page and the count
(`products/listing.py`), so `total` always matches the rows (CAT-32).
`in_stock=true` keeps the products with a buyable variant (stock or
backorder). `on_sale=true&list_price=true` also counts a list price above
the price (the AZA storefront strikes it, STO-11); `list_price` alone does
nothing. `sort=price|-price` orders by the price the cart charges
(CAT-15). `include_subcategories=true` makes a category page show its
whole branch; without it only the main category counts, as before.
A soft-deleted product is never public, even if `is_active` stayed true.



## OpenAPI

````yaml https://api.vellaro.io/openapi/storefront.json get /api/v1/products
openapi: 3.1.0
info:
  title: Vellaro Storefront API
  description: >-
    The API of storefronts and mobile apps. The store comes from the publishable
    key in the `X-Vellaro-Key` header (or from the store's domain); the
    customer's endpoints also take the customer's token as `Authorization:
    Bearer <access_token>`.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Authentication
    description: >-
      Customer sign-up and login, tokens, password reset, email verification,
      Google and Apple login, two-factor authentication.
  - name: Catalog
    description: Products, categories and brands, with filters, sorting and pagination.
  - name: Search
    description: Full-text product search and suggestions as you type.
  - name: Cart
    description: >-
      The cart of a guest (`X-Cart-Token`) or of the logged-in customer, and the
      extra warranty offered on a product page.
  - name: Checkout & orders
    description: >-
      Checkout, the customer's orders and reorder, «Order on WhatsApp» (cart
      codes, clicks).
  - name: Payments
    description: >-
      The store's payment methods, paying an order again, and the confirmation
      steps of PayPal, PokPay and Iute.
  - name: Account
    description: >-
      The logged-in customer: profile, addresses, wishlist, digital downloads,
      subscriptions, affiliate account.
  - name: Reviews & questions
    description: Product reviews and product questions.
  - name: AI chat
    description: 'The store''s AI shopping assistant: conversations, messages, feedback.'
  - name: Content
    description: CMS pages, menus, banners, flipbooks and information pages.
  - name: Marketing & contact
    description: >-
      Newsletter sign-up and email links, the contact form, campaign click
      tracking.
  - name: Store
    description: >-
      The store for the storefront: brand, public settings, languages,
      translations, currencies, physical stores, theme.
  - name: Devices
    description: Push-notification devices of the mobile app.
paths:
  /api/v1/products:
    get:
      tags:
        - Catalog
      summary: List Products
      description: >-
        Public paginated product listing with filters.


        Every filter is one predicate shared by the page and the count

        (`products/listing.py`), so `total` always matches the rows (CAT-32).

        `in_stock=true` keeps the products with a buyable variant (stock or

        backorder). `on_sale=true&list_price=true` also counts a list price
        above

        the price (the AZA storefront strikes it, STO-11); `list_price` alone
        does

        nothing. `sort=price|-price` orders by the price the cart charges

        (CAT-15). `include_subcategories=true` makes a category page show its

        whole branch; without it only the main category counts, as before.

        A soft-deleted product is never public, even if `is_active` stayed true.
      operationId: list_products_api_v1_products_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 24
            title: Page Size
        - name: category_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Category Id
        - name: include_subcategories
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              With category_id: also the products of its subcategories and the
              products linked to them, not only those with it as main category
            default: false
            title: Include Subcategories
          description: >-
            With category_id: also the products of its subcategories and the
            products linked to them, not only those with it as main category
        - name: brand_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Brand Id
        - name: is_featured
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            title: Is Featured
        - name: in_stock
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            title: In Stock
        - name: on_sale
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: Only products with an active discount
            title: On Sale
          description: Only products with an active discount
        - name: list_price
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              With on_sale=true: also the products whose list price
              (compare_at_price) is above the price, for a storefront that
              strikes it
            default: false
            title: List Price
          description: >-
            With on_sale=true: also the products whose list price
            (compare_at_price) is above the price, for a storefront that strikes
            it
        - name: min_price
          in: query
          required: false
          schema:
            anyOf:
              - type: number
              - type: string
                pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
              - type: 'null'
            description: Minimum price filter
            title: Min Price
          description: Minimum price filter
        - name: max_price
          in: query
          required: false
          schema:
            anyOf:
              - type: number
              - type: string
                pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
              - type: 'null'
            description: Maximum price filter
            title: Max Price
          description: Maximum price filter
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Text search on name
            title: Q
          description: Text search on name
        - name: sort
          in: query
          required: false
          schema:
            type: string
            pattern: ^(sort_order|name|-name|price|-price|created_at|-created_at)$
            default: sort_order
            title: Sort
        - name: lang
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Force content language (it|en|sq)
            title: Lang
          description: Force content language (it|en|sq)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_list_ProductListOut__'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ApiResponse_list_ProductListOut__:
      properties:
        data:
          anyOf:
            - items:
                $ref: '#/components/schemas/ProductListOut'
              type: array
            - type: 'null'
          title: Data
        meta:
          anyOf:
            - $ref: '#/components/schemas/PaginationMeta'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      title: ApiResponse[list[ProductListOut]]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProductListOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        slug:
          type: string
          title: Slug
        short_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Short Description
        name_i18n:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Name I18N
        category_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Category Id
        brand_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Brand Id
        is_featured:
          type: boolean
          title: Is Featured
        is_active:
          type: boolean
          title: Is Active
        sort_order:
          type: integer
          title: Sort Order
        created_at:
          type: string
          format: date-time
          title: Created At
        price:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Price
        sale_price:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Sale Price
        sku:
          anyOf:
            - type: string
            - type: 'null'
          title: Sku
        stock:
          anyOf:
            - type: integer
            - type: 'null'
          title: Stock
        stock_status:
          anyOf:
            - type: string
              enum:
                - in
                - low
                - out
            - type: 'null'
          title: Stock Status
        primary_image_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Primary Image Url
        card:
          anyOf:
            - $ref: >-
                #/components/schemas/app__modules__products__schemas__ProductCardOut
            - type: 'null'
      type: object
      required:
        - id
        - name
        - slug
        - short_description
        - category_id
        - brand_id
        - is_featured
        - is_active
        - sort_order
        - created_at
      title: ProductListOut
      description: Lightweight DTO for listing — no variants detail.
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - page_size
        - total
        - total_pages
      title: PaginationMeta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    app__modules__products__schemas__ProductCardOut:
      properties:
        brand_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Name
        compare_at_price:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Compare At Price
        variant_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Variant Id
        variant_count:
          type: integer
          title: Variant Count
          default: 0
        attributes:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Attributes
        swatches:
          items:
            $ref: '#/components/schemas/ProductSwatchOut'
          type: array
          title: Swatches
        swatch_count:
          type: integer
          title: Swatch Count
          default: 0
        rating_avg:
          anyOf:
            - type: number
            - type: 'null'
          title: Rating Avg
        rating_count:
          type: integer
          title: Rating Count
          default: 0
        stock_status_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Stock Status Name
        is_new:
          type: boolean
          title: Is New
          default: false
      type: object
      title: ProductCardOut
      description: >-
        What a v3 card shows besides name, price and image (TPL-4).


        `brand_name`, `compare_at_price`, the first active variant and its

        attributes come from rows the listing already loads. Swatches, rating
        and

        the stock-status label are filled by the public listing only.
    ProductSwatchOut:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        color:
          anyOf:
            - type: string
            - type: 'null'
          title: Color
        image:
          anyOf:
            - type: string
            - type: 'null'
          title: Image
      type: object
      title: ProductSwatchOut
      description: A colour (or fabric) the product comes in, for the card swatches.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.