Skip to main content

Inventory Item Ledgers

Schema​

InventoryItemLedger​

NameTypeDescriptionExample
idIDUnique identifier for inventory item ledgers"ckmnpybisiy5x08abky4g2d1f"
createdAtDateTimeWhen this inventory item ledger was created"2021-03-24 17:26:46.983Z"
updatedAtDateTimeWhen this inventory item ledger was updated"2021-03-24 17:26:46.983Z"
balanceFloatThe balance of the inventory item ledger100.0
minQuantityFloatThe minimum quantity of the inventory item ledger10.0
inventoryItemInventoryItemThe inventory item associated with this ledger{}
inventoryItemLedgerSublocationsInventoryItemLedgerSublocationThe sublocations ledgers associated with this ledger[]
jobJobThe job associated with this ledger{}
locationLocationThe location associated with this ledger{}

Queries​

inventoryItemLedger​

Get a single inventory item ledger by ID.

Parameters​

NameTypeDescription
idIDID of the inventory item ledger to fetch

Response​

A single InventoryItemLedger.

Example Request​

query {
inventoryItemLedger(id: "ckb91igzt01e90733giki0v0p") {
id
}
}

Example Response​

{
"id": "ckb91igzt01e90733giki0v0p",
}

inventoryItemLedgers​

Get a list of inventory item ledgers.

Parameters​

Accepts all standard pagination parameters.

Allowed orderBy fields: createdAt, id, updatedAt.

Allowed filter fields: createdAt, id, locationId, jobId, inventoryItemId, updatedAt.

Response​

A list of InventoryItemLedgers objects.

Example Request​

query {
inventoryItemLedgers {
id
}
}

Example Response​

[
{
"id": "ckb91igzt01e90733giki0v0p",
}
]