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

# List Inventory

> The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters.



## OpenAPI

````yaml /api-reference/products/openapi.json get /products/inventory
openapi: 3.0.0
info:
  title: Products API
  description: Documentation for products API
  version: '1.0'
  contact: {}
servers:
  - url: https://services.leadconnectorhq.com
security: []
tags:
  - name: Products
    description: Documentation for products API
  - name: Prices
    description: Documentation for products API
  - name: Store
    description: Documentation for products API
  - name: Collections
    description: Documentation for products API
  - name: Reviews
    description: Documentation for products API
paths:
  /products/inventory:
    get:
      tags:
        - Prices
      summary: List Inventory
      description: >-
        The "List Inventory API allows the user to retrieve a paginated list of
        inventory items. Use this endpoint to fetch details for multiple items
        in the inventory based on the provided query parameters.
      operationId: get-list-inventory
      parameters:
        - name: Version
          in: header
          description: API Version
          required: true
          schema:
            type: string
            enum:
              - '2021-07-28'
        - name: limit
          required: false
          in: query
          description: >-
            The maximum number of items to be included in a single page of
            results
          schema:
            default: 0
            example: 20
            type: number
        - name: offset
          required: false
          in: query
          description: >-
            The starting index of the page, indicating the position from which
            the results should be retrieved.
          schema:
            default: 0
            example: 0
            type: number
        - name: altId
          required: true
          in: query
          description: Location Id or Agency Id
          schema:
            example: 6578278e879ad2646715ba9c
            type: string
        - name: altType
          required: true
          in: query
          schema:
            type: string
            enum:
              - location
        - name: search
          required: false
          in: query
          description: Search string for Variant Search
          schema:
            example: Product Name
            type: string
        - name: trackInventory
          required: false
          in: query
          description: Filter by track inventory status
          schema:
            example: true
            type: boolean
        - name: allowOutOfStockPurchases
          required: false
          in: query
          description: Filter by allow out of stock purchases status
          schema:
            example: true
            type: boolean
        - name: isDigitalProduct
          required: false
          in: query
          description: Filter by digital product status
          schema:
            example: false
            type: boolean
        - name: availableQuantityFrom
          required: false
          in: query
          description: Filter by minimum available quantity
          schema:
            example: 10
            type: number
        - name: availableQuantityTo
          required: false
          in: query
          description: Filter by maximum available quantity
          schema:
            example: 100
            type: number
        - name: collectionIds
          required: false
          in: query
          description: Filter by collection IDs (comma-separated)
          schema:
            example: 64a1b2c3d4e5f6789abcdef0,64a1b2c3d4e5f6789abcdef1
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInventoryResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestDTO'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedDTO'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableDTO'
      security:
        - Location-Access:
            - products/prices.readonly
        - Agency-Access:
            - products/prices.readonly
components:
  schemas:
    GetInventoryResponseDto:
      type: object
      properties:
        inventory:
          description: List of inventory items
          type: array
          items:
            $ref: '#/components/schemas/InventoryItemDto'
        total:
          type: object
          description: Total count of inventory items
          example:
            total: 100
      required:
        - inventory
        - total
    BadRequestDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        message:
          type: string
          example: Bad Request
      required:
        - statusCode
        - message
    UnauthorizedDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        message:
          type: string
          example: 'Invalid token: access token is invalid'
        error:
          type: string
          example: Unauthorized
      required:
        - statusCode
        - message
        - error
    UnprocessableDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 422
        message:
          type: array
          items:
            type: string
          example:
            - Unprocessable Entity
        error:
          type: string
          example: Unprocessable Entity
      required:
        - statusCode
        - message
        - error
    InventoryItemDto:
      type: object
      properties:
        _id:
          type: string
          description: The unique identifier for the price
          example: 6241712be68f7a98102ba272
        name:
          type: string
          description: Name of the price/variant
          example: Medium T-shirt
        availableQuantity:
          type: number
          description: Available quantity in inventory
          example: 50
        sku:
          type: string
          description: SKU for the product variant
          example: TSHIRT-MED-001
        allowOutOfStockPurchases:
          type: boolean
          description: Whether out of stock purchases are allowed
          example: false
        product:
          type: string
          description: Product ID this price belongs to
          example: 6241712be68f7a98102ba270
        updatedAt:
          type: string
          description: Last update timestamp
          example: '2023-12-12T09:27:42.355Z'
        image:
          type: string
          description: Product image URL
          example: https://example.com/images/product.jpg
        productName:
          type: string
          description: Product name
          example: T-shirt
      required:
        - _id
        - name
        - availableQuantity
        - sku
        - allowOutOfStockPurchases
        - product
        - updatedAt

````