Skip to main content

InventoryTransaction

A single inventory movement event — every time stock enters, leaves, or moves within your facility.

transactionIdstring

Unique identifier for the transaction.

Example: TXN-00892
typestring

The type of inventory movement:

  • intake — goods received into inventory, typically from a purchase order.
  • outtake — goods consumed or shipped, typically by a work order or sales order.
  • adjustment — manual correction to quantity (e.g., after a physical count).
  • move — transfer between warehouse locations within the same facility.
  • return — goods sent back to a vendor.

Possible values: [intake, outtake, adjustment, move, return]

Example: intake
inventoryCodestring

The inventory tracking code for the item involved (e.g., INV-000312).

Example: INV-000312
itemNamestring

Display name of the item involved.

Example: Organic Tahini
quantitynumber

The quantity moved in this transaction, in the specified unit.

Example: 200
unitstring

Unit of measure for the quantity.

Example: lbs
referenceTypestring

The type of record that triggered this transaction (e.g., purchase_order, work_order, sales_order). Null for manual adjustments.

Example: purchase_order
referenceIdstring

The identifier of the source record (e.g., a PO number or work order number). Use this to trace the transaction back to its origin.

Example: PO-2025-0471
purposestring

A short label describing why the transaction occurred (e.g., "production", "receiving", "cycle count").

reasonstring

Reason code or explanation, typically used for adjustments and returns.

notesstring

Free-text operator notes attached to the transaction.

timestampstring<date-time>

When the transaction was recorded (ISO 8601).

Example: 2025-03-15T10:45:00Z
InventoryTransaction
{
"transactionId": "TXN-00892",
"type": "intake",
"inventoryCode": "INV-000312",
"itemName": "Organic Tahini",
"quantity": 200,
"unit": "lbs",
"referenceType": "purchase_order",
"referenceId": "PO-2025-0471",
"purpose": "string",
"reason": "string",
"notes": "string",
"timestamp": "2025-03-15T10:45:00Z"
}