Materials & logistics

Logistics

Explore the data types and operations available in Logistics.

132 operations

assessFulfillmentRequirementsQuery

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

attributeShipmentItemEvidenceMutation

attributeShipmentItemEvidence; validates structure and permissions without lifecycle gating

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

completeOrderFulfillmentMutation

Explicitly complete an order when all its planned quantities satisfy the current milestone; never fabricate delivery or reopen completed work

consumeMaterialLotMutation

Final consumption: atomically debit source on-hand and reserved quantities and update reservation summary. Requires a resolved, active non-quarantined holding. Shares authority with allocated issueStockToProduction.

createCarrierMutation

Create a new carrier. Requires carrier:write permission.

createCustomerFulfillmentDefaultMutation

createCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects

createEntityNoteMutation

Save note changes independently of embedding success

createFulfillmentRequirementMutation

createFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects

createJobMaterialReservationMutation

Create a new job material reservation. Requires jobMaterialReservation:write permission.

createPlannedDeliveryMutation

createPlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:write

createPlannedDeliveryItemMutation

createPlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:write

createPurchaseOrderMutation

Create a purchase order with lines, computing totals automatically. Requires purchaseOrder:write.

createShipmentMutation

Create a new shipment. Requires shipment:write permission.

createShipmentItemMutation

Create a new shipment item. Requires shipment:write permission.

createShipmentItemAllocationMutation

createShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:write and shipment:write

createShipmentPackageMutation

Create a new shipment package. Requires shipment:write permission.

createWarehouseLocationMutation

Create a warehouse location in the caller's tenant and emit a created event. Returns validation errors instead of a location when the input is invalid. Requires warehouseLocation:write permission.

createWarehouseStockMutation

Create a warehouse stock record in the caller's tenant with a server-assigned WarehouseStock TypeID. Returns validation errors rather than a record when the quantities are invalid. Emits a warehouse-stock created event. Requires write access to warehouse stock.

createWarehouseTransferMutation

Create a warehouse transfer in the caller's tenant. Returns validation errors instead of saving when source and destination match or quantity is not positive. Requires warehouseTransfer:write permission.

dailyDispatchManifestQuery

Fetch all shipments for a given date with packages, items, and order details. Requires shipment:list.

dataChangeEventsSubscription

Subscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).

deleteCarrierMutation

Delete a carrier. Requires carrier:delete permission.

deleteEntityNoteMutation

Save note changes independently of embedding success

deleteJobMaterialReservationMutation

Delete a job material reservation. Requires jobMaterialReservation:delete permission.

deletePlannedDeliveryMutation

deletePlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:delete

deletePlannedDeliveryItemMutation

deletePlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:delete

deleteShipmentMutation

Delete a shipment. Requires shipment:delete permission.

deleteShipmentItemMutation

Delete a shipment item. Requires shipment:delete permission.

deleteShipmentItemAllocationMutation

deleteShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:delete and shipment:write

deleteShipmentPackageMutation

Delete a shipment package. Requires shipment:delete permission.

deleteWarehouseLocationMutation

Delete a warehouse location from the caller's tenant and emit a deleted event. Reports a not-found result when no such location exists. Requires warehouseLocation:delete permission.

deleteWarehouseStockMutation

Permanently delete a warehouse stock record from the caller's tenant. Reports not-found when no such record exists. Emits a warehouse-stock deleted event. Requires delete access to warehouse stock.

deleteWarehouseTransferMutation

Permanently delete a warehouse transfer from the caller's tenant. Reports not-found rather than failing when no such transfer exists. Requires warehouseTransfer:delete permission.

dispatchShipmentMutation

Create a shipment with packages and items, marking it as picked up. Requires shipment:write.

effectiveFulfillmentRequirementsQuery

Authoritative copied/local requirements and explicit exceptions, with review diagnostics; does not infer execution satisfaction

entityNotesQuery

Read operational notes with current target permissions

fulfillmentImpactQuery

Entities reachable up/downstream from a fulfillment entity (the seed is excluded). Requires fulfillment:read permission.

fulfillmentTraceQuery

Lineage subgraph (nodes + edges) around a fulfillment entity. Requires fulfillment:read permission.

generateDefaultDataQueryQuery

Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.

getCarrierQuery

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

getCustomerFulfillmentDefaultQuery

getCustomerFulfillmentDefault; tenant-scoped and permission checked

getEntityNoteQuery

Read operational notes with current target permissions

getEntityNoteBySourceQuery

Read operational notes with current target permissions

getFulfillmentRequirementQuery

getFulfillmentRequirement; tenant-scoped and permission checked

getJobMaterialReservationQuery

Fetch a single job material reservation by ID. Requires jobMaterialReservation:read permission.

getMagicQueryGraphQLQuery

Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getMaterialLotQuery

Read an input allocation in the current tenant; requires warehouse stock read permission

getPlannedDeliveryQuery

getPlannedDelivery; requires plannedDelivery:read