Materials & logistics
Logistics
Explore the data types and operations available in Logistics.
132 operations
getPlannedDeliveryItem; requires plannedDelivery:read
getRequirementEvidenceQuerygetRequirementEvidence; read-only, no inferred completion or macro gate
getShipmentQueryFetch a shipment by ID. Requires shipment:read permission.
getShipmentItemQueryFetch a shipment item by ID. Requires shipment:read permission.
getShipmentItemAllocationQuerygetShipmentItemAllocation; requires plannedDelivery:read
getShipmentItemEvidenceQuerygetShipmentItemEvidence; tenant-scoped evidence without inferred completion
getShipmentPackageQueryFetch a shipment package by ID. Requires shipment:read permission.
getWarehouseLocationQueryFetch a single warehouse location in the caller's tenant by id; null when no such location exists. Requires warehouseLocation:read permission.
getWarehouseStockQueryFetch a single warehouse stock record in the caller's tenant. Returns null when no such record exists. Requires read access to warehouse stock.
getWarehouseTransferQueryFetch a single warehouse transfer in the caller's tenant, or null when no such transfer exists. Requires warehouseTransfer:read permission.
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
iacGuidesQueryEvery authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
issueStockToProductionMutationIssue warehouse stock to production, creating transfers and reducing quantities. Requires warehouseStock:write.
listCarriersQueryList carriers with pagination. Requires carrier:list permission.
listCustomerFulfillmentDefaultsQuerylistCustomerFulfillmentDefaults; tenant-scoped and permission checked
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listFulfillmentRequirementsQuerylistFulfillmentRequirements; tenant-scoped and permission checked
listJobMaterialReservationsQueryList material reservations with pagination. Requires jobMaterialReservation:list permission.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listPlannedDeliveriesQuerylistPlannedDeliveries; requires plannedDelivery:list
listPlannedDeliveryItemsQuerylistPlannedDeliveryItems; requires plannedDelivery:list
listRequirementEvidenceQuerylistRequirementEvidence; read-only, no inferred completion or macro gate
listShipmentItemAllocationsQuerylistShipmentItemAllocations; requires plannedDelivery:list
listShipmentItemEvidenceQuerylistShipmentItemEvidence; tenant-scoped evidence without inferred completion
listShipmentItemsQueryList shipment items with pagination. Requires shipment:list permission.
listShipmentPackagesQueryList shipment packages with pagination. Requires shipment:list permission.
listShipmentsQueryList shipments with pagination. Requires shipment:list permission.
listWarehouseLocationsQueryList the caller's tenant's warehouse locations, filtered and sorted, as a paginated connection. Requires warehouseLocation:list permission.
listWarehouseStocksQueryList the warehouse stock records in the caller's tenant, filtered, sorted and paginated. Requires list access to warehouse stock.
listWarehouseTransfersQueryList the warehouse transfers in the caller's tenant as a paginated connection. Requires warehouseTransfer:list permission.
magicQueryQueryExecutes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
moveOperationProductMutationAtomically relocate produced stock without merging holdings or changing total quantity. Every attempt is authorized, including retry replay.
orderFulfillmentCompletionQueryAssess current policy across every order line using explicitly attributed quantities
performStockCountMutationPerform a stock count, adjusting quantities and recording differences. Requires warehouseStock:write.
pingQueryHealth check endpoint
plannedItemFulfillmentBalanceQueryplannedItemFulfillmentBalance; tenant-scoped evidence without inferred completion
plannedItemReviewQueryReview a planned item using shared balances, effective requirements, assessment and authorized notes
provenanceImpactQueryEntities reachable up/downstream from a provenance entity (the seed is excluded), over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
provenanceTraceQueryCross-layer lineage subgraph (nodes + edges) around a provenance entity, over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
receivePurchaseOrderMutationRecord receipt of purchase order lines, optionally adding to warehouse stock. Requires purchaseOrder:write.
recordRequirementEvidenceMutationRecords evidence without running approvals, sending messages or enforcing lifecycle rules
recordShipmentItemEvidenceMutationrecordShipmentItemEvidence; validates structure and permissions without lifecycle gating
reindexEntityNotesMutationQueue bounded recoverable indexing work using the current model
releaseMaterialLotMutationRelease commitment without consuming stock. Resolved lots release matching holding and reservation counters; unresolved lots change no stock. Release reopens demand, so a future reserveJobMaterials may allocate it again.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
reserveJobMaterialsMutationAttempt to reserve warehouse stock for all pending material reservations on a job. Requires jobMaterialReservation:write permission.