title: Inventory Count
x-tags:
  - Inventory Management
type: object
description: Represents the current count of a given catalog model that is tracked by the inventory system.
properties:
  uuid:
    type: string
    format: uuid
    description: The count's unique identifier.
    readOnly: true
  outlet:
    type: string
    format: uuid
    description: The UUID of the associated outlet.
    readOnly: true
  catalog_model:
    type: string
    format: uuid
    description: The UUID of the associated catalog model.
    readOnly: true
  catalog_model_type:
    enum:
      - item
      - modifier
    description: The type of the associated catalog model.
  status:
    $ref: ./InventoryCountStatus.yaml
    description: The current status of the count.
  available_quantity:
    type: integer
    format: int64
    description: |-
      The currently-available quantity of the model.

      This value can be negative.
    example: 22
    readOnly: true
  low_stock_notification:
    type:
      - integer
      - 'null'
    description: The quantity that will trigger a low-stock notification to the merchant.
    minimum: 0
    example: 5
    format: int64
  calculated_at:
    type: string
    format: date-time
    description: The date-time that the count was last calculated (with millisecond precision).
    example: '2025-03-07T14:15:22.456Z'
  created_at:
    type: string
    format: date-time
    description: The date-time that the count was created.
    readOnly: true
