Materials & logistics

Logistics

Explore the data types and operations available in Logistics.

132 operations

getPlannedDeliveryItemQuery

getPlannedDeliveryItem; requires plannedDelivery:read

getRequirementEvidenceQuery

getRequirementEvidence; read-only, no inferred completion or macro gate

getShipmentQuery

Fetch a shipment by ID. Requires shipment:read permission.

getShipmentItemQuery

Fetch a shipment item by ID. Requires shipment:read permission.

getShipmentItemAllocationQuery

getShipmentItemAllocation; requires plannedDelivery:read

getShipmentItemEvidenceQuery

getShipmentItemEvidence; tenant-scoped evidence without inferred completion

getShipmentPackageQuery

Fetch a shipment package by ID. Requires shipment:read permission.

getWarehouseLocationQuery

Fetch a single warehouse location in the caller's tenant by id; null when no such location exists. Requires warehouseLocation:read permission.

getWarehouseStockQuery

Fetch a single warehouse stock record in the caller's tenant. Returns null when no such record exists. Requires read access to warehouse stock.

getWarehouseTransferQuery

Fetch a single warehouse transfer in the caller's tenant, or null when no such transfer exists. Requires warehouseTransfer:read permission.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

Every 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.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

issueStockToProductionMutation

Issue warehouse stock to production, creating transfers and reducing quantities. Requires warehouseStock:write.

listCarriersQuery

List carriers with pagination. Requires carrier:list permission.

listCustomerFulfillmentDefaultsQuery

listCustomerFulfillmentDefaults; tenant-scoped and permission checked

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listFulfillmentRequirementsQuery

listFulfillmentRequirements; tenant-scoped and permission checked

listJobMaterialReservationsQuery

List material reservations with pagination. Requires jobMaterialReservation:list permission.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listPlannedDeliveriesQuery

listPlannedDeliveries; requires plannedDelivery:list

listPlannedDeliveryItemsQuery

listPlannedDeliveryItems; requires plannedDelivery:list

listRequirementEvidenceQuery

listRequirementEvidence; read-only, no inferred completion or macro gate

listShipmentItemAllocationsQuery

listShipmentItemAllocations; requires plannedDelivery:list

listShipmentItemEvidenceQuery

listShipmentItemEvidence; tenant-scoped evidence without inferred completion

listShipmentItemsQuery

List shipment items with pagination. Requires shipment:list permission.

listShipmentPackagesQuery

List shipment packages with pagination. Requires shipment:list permission.

listShipmentsQuery

List shipments with pagination. Requires shipment:list permission.

listWarehouseLocationsQuery

List the caller's tenant's warehouse locations, filtered and sorted, as a paginated connection. Requires warehouseLocation:list permission.

listWarehouseStocksQuery

List the warehouse stock records in the caller's tenant, filtered, sorted and paginated. Requires list access to warehouse stock.

listWarehouseTransfersQuery

List the warehouse transfers in the caller's tenant as a paginated connection. Requires warehouseTransfer:list permission.

magicQueryQuery

Executes 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.

moveOperationProductMutation

Atomically relocate produced stock without merging holdings or changing total quantity. Every attempt is authorized, including retry replay.

orderFulfillmentCompletionQuery

Assess current policy across every order line using explicitly attributed quantities

performStockCountMutation

Perform a stock count, adjusting quantities and recording differences. Requires warehouseStock:write.

pingQuery

Health check endpoint

plannedItemFulfillmentBalanceQuery

plannedItemFulfillmentBalance; tenant-scoped evidence without inferred completion

plannedItemReviewQuery

Review a planned item using shared balances, effective requirements, assessment and authorized notes

provenanceImpactQuery

Entities reachable up/downstream from a provenance entity (the seed is excluded), over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.

provenanceTraceQuery

Cross-layer lineage subgraph (nodes + edges) around a provenance entity, over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.

receivePurchaseOrderMutation

Record receipt of purchase order lines, optionally adding to warehouse stock. Requires purchaseOrder:write.

recordRequirementEvidenceMutation

Records evidence without running approvals, sending messages or enforcing lifecycle rules

recordShipmentItemEvidenceMutation

recordShipmentItemEvidence; validates structure and permissions without lifecycle gating

reindexEntityNotesMutation

Queue bounded recoverable indexing work using the current model

releaseMaterialLotMutation

Release 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.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

reserveJobMaterialsMutation

Attempt to reserve warehouse stock for all pending material reservations on a job. Requires jobMaterialReservation:write permission.