YQueue DocsDevelopers

Schema

Inventory Adjustment

Represents an adjustment that has been performed against a given catalog model that is tracked by the inventory system.

  • Inventory Management

Overview

object · 9 properties · 0 required

Properties

uuid

string

The adjustment'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

type

reference

The type of adjustment. A `manual_count` overrides the existing value of the count and sets it to mtach `adjusted_quantity`, while all other adjustments simply increment/deincrement the existing value of the count.

References Inventory Adjustment Type.

adjusted_quantity

integer

The quantity that was adjusted/set.

Format int64
Minimum 0

updated_quantity

integer

The quantity available of the model immediately after applying the adjustment. This value can be negative.

Format int64
Read only Yes

description

string | null

A human-readable description of the adjustment (if any).

Min length 1
Max length 255
Nullable Yes
Read only Yes

created_at

string

The date-time that the adjustment was created.

Format date-time
Read only Yes

Used by

Raw YAML
Download source
title: Inventory Adjustment
x-tags:
  - Inventory Management
type: object
description: Represents an adjustment that has been performed against a given catalog model that is tracked by the inventory system.
properties:
  uuid:
    type: string
    format: uuid
    description: The adjustment'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.
  type:
    $ref: ./InventoryAdjustmentType.yaml
    description: |-
      The type of adjustment.

      A `manual_count` overrides the existing value of the count and sets it to mtach `adjusted_quantity`, while all other adjustments simply increment/deincrement the existing value of the count.
  adjusted_quantity:
    type: integer
    minimum: 0
    format: int64
    description: The quantity that was adjusted/set.
  updated_quantity:
    type: integer
    format: int64
    description: |-
      The quantity available of the model immediately after applying the adjustment.

      This value can be negative.
    readOnly: true
  description:
    type:
      - string
      - 'null'
    minLength: 1
    maxLength: 255
    description: A human-readable description of the adjustment (if any).
    readOnly: true
  created_at:
    type: string
    format: date-time
    description: The date-time that the adjustment was created.
    readOnly: true

Search documentation

Search across this documentation site.