> ## 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.

# Admin List Products

> Admin paginated product listing.

Includes inactive (unpublished) products so they stay editable, but
excludes soft-deleted ones (deleted_at IS NOT NULL) — those are gone.

`in_stock` is a SQL predicate on the page AND the count: it used to be
applied in Python after the pagination (wrong `total`, short pages) and
`false` did nothing (CAT-9). `q` also matches slug and SKU (CAT-24).



## OpenAPI

````yaml https://api.vellaro.io/openapi/admin.json get /api/v1/admin/products
openapi: 3.1.0
info:
  title: Vellaro Admin API
  description: >-
    Store management under `/api/v1/admin`, for back ends and integrations.
    Every call takes `Authorization: Bearer <token>`: an admin API token or a
    staff user's token. The permissions of its role decide what it can do,
    always in its own store.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Orders
    description: >-
      Orders and manual orders, payments, refunds, shipments, invoices, returns,
      customer subscriptions.
  - name: Products
    description: Products, variants, images, prices and discounts, product lookups.
  - name: Categories & catalog setup
    description: >-
      Categories, brands, attributes, options, filters, downloadable files,
      recurring profiles.
  - name: Inventory
    description: Stock of the variants and stock statuses.
  - name: Customers
    description: Customers, customer groups, custom fields.
  - name: Reviews & questions
    description: Moderation of product reviews and questions.
  - name: Promotions & coupons
    description: Coupons and gift vouchers.
  - name: Marketing
    description: Campaigns, newsletter subscribers, affiliates and their commissions.
  - name: Content
    description: >-
      CMS pages, menus, banners, information pages, flipbooks, media library,
      SEO URLs, email templates, translations.
  - name: Settings
    description: >-
      Store settings, email delivery, languages, currencies, physical stores,
      social login providers.
  - name: Shipping
    description: Couriers, shipping rates, weight and length classes.
  - name: Taxes & geo
    description: Tax classes, rates and rules; countries, zones and geo zones.
  - name: Integrations & modules
    description: >-
      Integrations, plugins and modules (Iute, extra warranty, Nextera, Financa
      5, WhatsApp, Firebase), outbound webhooks.
  - name: AI
    description: AI content generation and the settings of the AI shopping assistant.
  - name: Imports
    description: 'CSV imports and the universal import: runs, mappings, previews, undo.'
  - name: Reports & dashboard
    description: Dashboard figures and reports.
  - name: Users & API keys
    description: Staff users and roles, publishable keys, admin API tokens.
  - name: Audit
    description: The store's audit log.
paths:
  /api/v1/admin/products:
    get:
      tags:
        - Products
      summary: Admin List Products
      description: |-
        Admin paginated product listing.

        Includes inactive (unpublished) products so they stay editable, but
        excludes soft-deleted ones (deleted_at IS NOT NULL) — those are gone.

        `in_stock` is a SQL predicate on the page AND the count: it used to be
        applied in Python after the pagination (wrong `total`, short pages) and
        `false` did nothing (CAT-9). `q` also matches slug and SKU (CAT-24).
      operationId: admin_list_products_api_v1_admin_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: 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: is_active
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            title: Is Active
        - name: in_stock
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: >-
              true: a buyable active variant (stock or backorder); false: none
              (out of stock, or no active variant)
            title: In Stock
          description: >-
            true: a buyable active variant (stock or backorder); false: none
            (out of stock, or no active variant)
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 100
              - type: 'null'
            description: Name, slug or variant SKU
            title: Q
          description: Name, slug or variant SKU
        - 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'
      security:
        - HTTPBearer: []
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.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

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