Schema
Inventory Adjustment
Represents an adjustment that has been performed against a given catalog model that is tracked by the inventory system.
Overview
Properties
uuid
The adjustment's unique identifier.
uuid
Yes
outlet
The UUID of the associated outlet.
uuid
Yes
catalog_model
The UUID of the associated catalog model.
uuid
Yes
catalog_model_type
The type of the associated catalog model.
Allowed values
itemmodifiertype
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
The quantity that was adjusted/set.
int64
0
updated_quantity
The quantity available of the model immediately after applying the adjustment. This value can be negative.
int64
Yes
description
A human-readable description of the adjustment (if any).
1
255
Yes
Yes
created_at
The date-time that the adjustment was created.
date-time
Yes
Used by
Raw YAML
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