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

# List inventory



## OpenAPI

````yaml /openapi_v4_core.json get /v4/core/companies/{companyId}/inventory
openapi: 3.0.0
info:
  title: Commenda Integrations V4 API
  description: Commenda Integrations — unified accounting, commerce, and CRM API.
  version: 4.0.0
  contact: {}
servers:
  - url: https://api.integrations.commenda.io
    description: Production
security:
  - api_key: []
tags: []
paths:
  /v4/core/companies/{companyId}/inventory:
    get:
      tags:
        - E-Commerce
      summary: List inventory
      operationId: list_inventory
      parameters:
        - name: companyId
          in: path
          required: true
          description: Commenda company id.
          schema:
            type: integer
        - name: limit
          in: query
          required: false
          description: Max records to return.
          schema:
            type: integer
            default: 20
            maximum: 100
        - name: next
          in: query
          required: false
          description: Cursor for the next page (from a previous response).
          schema:
            type: string
        - name: prev
          in: query
          required: false
          description: Cursor for the previous page.
          schema:
            type: string
        - name: include_deleted_records
          in: query
          required: false
          description: Include soft-deleted records.
          schema:
            type: boolean
        - name: return_count
          in: query
          required: false
          description: Include the total match count in the response.
          schema:
            type: boolean
        - name: item_id[eq]
          in: query
          required: false
          description: Exact match on item_id.
          schema:
            type: string
        - name: item_id[in]
          in: query
          required: false
          description: Comma-separated item_id values (OR match).
          schema:
            type: string
        - name: variant_id[eq]
          in: query
          required: false
          description: Exact match on variant_id.
          schema:
            type: string
        - name: variant_id[in]
          in: query
          required: false
          description: Comma-separated variant_id values (OR match).
          schema:
            type: string
        - name: sku[eq]
          in: query
          required: false
          description: Exact match on sku.
          schema:
            type: string
        - name: sku[in]
          in: query
          required: false
          description: Comma-separated sku values (OR match).
          schema:
            type: string
        - name: status[eq]
          in: query
          required: false
          description: Exact match on status.
          schema:
            type: string
            enum:
              - IN_STOCK
              - OUT_OF_STOCK
              - LOW_STOCK
              - DISCONTINUED
              - UNKNOWN
        - name: status[in]
          in: query
          required: false
          description: Comma-separated status values (OR match).
          schema:
            type: string
        - name: is_trackable[eq]
          in: query
          required: false
          description: Exact match on is_trackable.
          schema:
            type: string
        - name: is_trackable[in]
          in: query
          required: false
          description: Comma-separated is_trackable values (OR match).
          schema:
            type: string
        - name: rootfi_integration_type[eq]
          in: query
          required: false
          description: Exact match on rootfi_integration_type.
          schema:
            type: string
        - name: rootfi_integration_type[in]
          in: query
          required: false
          description: Comma-separated rootfi_integration_type values (OR match).
          schema:
            type: string
        - name: rootfi_updated_at[eq]
          in: query
          required: false
          description: Exact match on rootfi_updated_at.
          schema:
            type: string
        - name: rootfi_updated_at[in]
          in: query
          required: false
          description: Comma-separated rootfi_updated_at values (OR match).
          schema:
            type: string
        - name: rootfi_updated_at[gte]
          in: query
          required: false
          description: rootfi_updated_at greater-than-or-equal.
          schema:
            type: string
        - name: rootfi_updated_at[lte]
          in: query
          required: false
          description: rootfi_updated_at less-than-or-equal.
          schema:
            type: string
        - name: created_at[eq]
          in: query
          required: false
          description: Exact match on created_at.
          schema:
            type: string
        - name: created_at[in]
          in: query
          required: false
          description: Comma-separated created_at values (OR match).
          schema:
            type: string
        - name: created_at[gte]
          in: query
          required: false
          description: created_at greater-than-or-equal.
          schema:
            type: string
        - name: created_at[lte]
          in: query
          required: false
          description: created_at less-than-or-equal.
          schema:
            type: string
        - name: updated_at[eq]
          in: query
          required: false
          description: Exact match on updated_at.
          schema:
            type: string
        - name: updated_at[in]
          in: query
          required: false
          description: Comma-separated updated_at values (OR match).
          schema:
            type: string
        - name: updated_at[gte]
          in: query
          required: false
          description: updated_at greater-than-or-equal.
          schema:
            type: string
        - name: updated_at[lte]
          in: query
          required: false
          description: updated_at less-than-or-equal.
          schema:
            type: string
      responses:
        '200':
          description: A paginated list of inventory.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Inventory'
                      total_count:
                        type: integer
                      next:
                        type: string
                        nullable: true
                      prev:
                        type: string
                        nullable: true
                    required:
                      - data
                      - total_count
                      - next
                      - prev
                  request_id:
                    type: string
                required:
                  - data
                  - request_id
components:
  schemas:
    Inventory:
      type: object
      properties:
        rootfi_id:
          type: integer
          description: Unique identifier for this inventory record
        rootfi_created_at:
          type: string
          format: date-time
        rootfi_updated_at:
          type: string
          format: date-time
        rootfi_integration_type:
          type: string
          enum:
            - BUSY
            - CLEARBOOKS
            - FREEAGENT
            - FRESHBOOKS
            - KASHFLOW
            - MEKARI_JURNAL
            - MS_DYNAMICS_365
            - MS_DYNAMICS_365_FO
            - MYOB_BUSINESS
            - NETSUITE
            - ODOO_ACCOUNTING
            - QOYOD
            - QUICKBOOKS
            - QUICKBOOKS_SANDBOX
            - ROOTFI_SANDBOX
            - SAGE_CLOUD_ACCOUNTING
            - SAGE_ZA_CLOUD_ACCOUNTING
            - SAGE_INTACCT
            - TALLY
            - WAFEQ
            - WAVE
            - XERO
            - ZOHO_BOOKS
            - PUZZLE_SANDBOX
            - PUZZLE
            - RILLET
            - RILLET_SANDBOX
            - AMAZON
            - BIG_COMMERCE
            - SHOPIFY
            - SQUARESPACE
            - WIX
            - WOO_COMMERCE
            - GOOGLE_PLAYSTORE
            - CHARGEBEE
            - MOLLIE
            - PAYPAL
            - PAYPAL_SANDBOX
            - RAZORPAY
            - SQUARE
            - SQUARE_SANDBOX
            - STRIPE
            - STRIPE_TEST
            - STRIPE_SANDBOX
            - ZOHO_INVOICE
            - PADDLE
            - PADDLE_SANDBOX
            - HUBSPOT
            - PIPEDRIVE
            - SALES_FORCE
            - ZOHO_CRM
            - GUSTO
        platform_id:
          type: string
          description: Platform-specific inventory identifier
        item_id:
          type: string
          nullable: true
          description: Reference to the related item
        variant_id:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        sku:
          type: string
          nullable: true
        quantity:
          type: integer
          nullable: true
          description: Total quantity on hand
        reserved_quantity:
          type: integer
          nullable: true
          description: Quantity allocated to pending orders
        available_quantity:
          type: integer
          nullable: true
          description: Quantity available for new orders
        status:
          type: string
          enum:
            - IN_STOCK
            - OUT_OF_STOCK
            - LOW_STOCK
            - DISCONTINUED
            - UNKNOWN
          nullable: true
          description: '`IN_STOCK`, `LOW_STOCK`, `OUT_OF_STOCK`, `DISCONTINUED`'
        is_trackable:
          type: boolean
          nullable: true
        reorder_level:
          type: integer
          nullable: true
        reorder_quantity:
          type: integer
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
          description: Last update timestamp (ISO 8601)
      required:
        - rootfi_id
        - rootfi_created_at
        - rootfi_updated_at
        - rootfi_integration_type
        - platform_id
      description: >-
        Inventory tracks stock levels and availability for catalog items across
        e-commerce platforms.
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: api_key
      description: Your Commenda Integrations API key, sent in the `api_key` header.

````