Skip to content

API reference · Schema

V1InventoryTransfers

V1InventoryTransferscontract v1.inventory.transfers

itemsarray of objectrequired
- transfer_idUuid7required
- from_outlet_idUuid7required
- to_outlet_idUuid7required
- statusenum (3)required
  sentreceivedcancelled
- sent_byUuid7required
- sent_atIsoDatetimerequired
- received_byUuid7 | nullrequired
- received_atIsoDatetime | nullrequired
- linesarray of objectrequired
  - transfer_line_idUuid7required
  - ingredient_idUuid7required
  - batch_idUuid7 | nullrequired
  - qty_milliintegerrequired
    ≥ -9007199254740991≤ 9007199254740991
  - unitstringrequired
    pattern ^[a-z][a-z_]{0,15}$
next_cursorUuid7 | nullrequired

Used by

get/v1/inventory/transfersTransfers visible from either end (outlet = from or to), with their lines