YQueue DocsDevelopers

Schema

Inventory Count

Represents the current count of a given catalog model that is tracked by the inventory system.

  • Inventory Management

Overview

object · 9 properties · 0 required

Properties

uuid

string

The count's unique identifier.

Format uuid
Read only Yes

outlet

string

The UUID of the associated outlet.

Format uuid
Read only Yes

catalog_model

string

The UUID of the associated catalog model.

Format uuid
Read only Yes

catalog_model_type

enum

The type of the associated catalog model.

Allowed values

itemmodifier

status

reference

The current status of the count.

References Inventory Count Status.

available_quantity

integer

The currently-available quantity of the model. This value can be negative.

Format int64
Example 22
Read only Yes

low_stock_notification

integer | null

The quantity that will trigger a low-stock notification to the merchant.

Format int64
Example 5
Minimum 0
Nullable Yes

calculated_at

string

The date-time that the count was last calculated (with millisecond precision).

Format date-time
Example 2025-03-07T14:15:22.456Z

created_at

string

The date-time that the count was created.

Format date-time
Read only Yes

Used by

Raw YAML
Download source
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

Search documentation

Search across this documentation site.