Skip to main content

Inventory Item Ledger Sublocations

Schema​

InventoryItemLedgerSublocation​

NameTypeDescriptionExample
idIDUnique identifier for inventory item sublocations"ckmnpybisiy5x08abky4g2d1f"
createdAtDateTimeWhen this inventory item ledger sublocation was created"2021-03-24 17:26:46.983Z"
updatedAtDateTimeWhen this inventory item ledger sublocation was updated"2021-03-24 17:26:46.983Z"
isRootbooleanWhether the sublocation is a root sublocationtrue
quantityfloatQuantity of the item at this sublocation100
ledgerInventoryItemLedgerInventory item ledger associated with this sublocation ledgerSee InventoryItemLedger docs
sublocationSublocationSublocation associated with this inventory ledgerSee Sublocation docs

Queries​

inventoryItemLedgerSublocation​

Get a single inventory item ledger sublocation by ID.

Parameters​

NameTypeDescription
idIDID of the inventory item ledger sublocation to fetch

Response​

A single InventoryItemLedgerSublocation.

Example Request​

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

Example Response​

{
"id": "ckb91igzt01e90733giki0v0p",
}

inventoryItemLedgerSublocations​

Get a list of inventory item ledger sublocations.

Parameters​

Accepts all standard pagination parameters.

Allowed orderBy fields: createdAt, id, updatedAt.

Allowed filter fields: createdAt, id, isRoot, ledgerId, sublocationId, updatedAt.

Response​

A list of InventoryItemLedgerSublocation objects.

Example Request​

query {
inventoryItemLedgerSublocations {
id
}
}

Example Response​

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