Materials & logistics
Logistics
Explore the data types and operations available in Logistics.
132 operations
assessFulfillmentRequirements; read-only, no inferred completion or macro gate
attributeShipmentItemEvidenceMutationattributeShipmentItemEvidence; validates structure and permissions without lifecycle gating
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
completeOrderFulfillmentMutationExplicitly complete an order when all its planned quantities satisfy the current milestone; never fabricate delivery or reopen completed work
consumeMaterialLotMutationFinal 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.
createCarrierMutationCreate a new carrier. Requires carrier:write permission.
createCustomerFulfillmentDefaultMutationcreateCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
createEntityNoteMutationSave note changes independently of embedding success
createFulfillmentRequirementMutationcreateFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects
createJobMaterialReservationMutationCreate a new job material reservation. Requires jobMaterialReservation:write permission.
createPlannedDeliveryMutationcreatePlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:write
createPlannedDeliveryItemMutationcreatePlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:write
createPurchaseOrderMutationCreate a purchase order with lines, computing totals automatically. Requires purchaseOrder:write.
createShipmentMutationCreate a new shipment. Requires shipment:write permission.
createShipmentItemMutationCreate a new shipment item. Requires shipment:write permission.
createShipmentItemAllocationMutationcreateShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:write and shipment:write
createShipmentPackageMutationCreate a new shipment package. Requires shipment:write permission.
createWarehouseLocationMutationCreate 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.
createWarehouseStockMutationCreate 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.
createWarehouseTransferMutationCreate 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.
dailyDispatchManifestQueryFetch all shipments for a given date with packages, items, and order details. Requires shipment:list.
dataChangeEventsSubscriptionSubscribe 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).
deleteCarrierMutationDelete a carrier. Requires carrier:delete permission.
deleteEntityNoteMutationSave note changes independently of embedding success
deleteJobMaterialReservationMutationDelete a job material reservation. Requires jobMaterialReservation:delete permission.
deletePlannedDeliveryMutationdeletePlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:delete
deletePlannedDeliveryItemMutationdeletePlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:delete
deleteShipmentMutationDelete a shipment. Requires shipment:delete permission.
deleteShipmentItemMutationDelete a shipment item. Requires shipment:delete permission.
deleteShipmentItemAllocationMutationdeleteShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:delete and shipment:write
deleteShipmentPackageMutationDelete a shipment package. Requires shipment:delete permission.
deleteWarehouseLocationMutationDelete 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.
deleteWarehouseStockMutationPermanently 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.
deleteWarehouseTransferMutationPermanently delete a warehouse transfer from the caller's tenant. Reports not-found rather than failing when no such transfer exists. Requires warehouseTransfer:delete permission.
dispatchShipmentMutationCreate a shipment with packages and items, marking it as picked up. Requires shipment:write.
effectiveFulfillmentRequirementsQueryAuthoritative copied/local requirements and explicit exceptions, with review diagnostics; does not infer execution satisfaction
entityNotesQueryRead operational notes with current target permissions
fulfillmentImpactQueryEntities reachable up/downstream from a fulfillment entity (the seed is excluded). Requires fulfillment:read permission.
fulfillmentTraceQueryLineage subgraph (nodes + edges) around a fulfillment entity. Requires fulfillment:read permission.
generateDefaultDataQueryQueryGenerate 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.
getCarrierQueryFetch a carrier by ID. Requires carrier:read permission.
getCustomerFulfillmentDefaultQuerygetCustomerFulfillmentDefault; tenant-scoped and permission checked
getEntityNoteQueryRead operational notes with current target permissions
getEntityNoteBySourceQueryRead operational notes with current target permissions
getFulfillmentRequirementQuerygetFulfillmentRequirement; tenant-scoped and permission checked
getJobMaterialReservationQueryFetch a single job material reservation by ID. Requires jobMaterialReservation:read permission.
getMagicQueryGraphQLQueryResolves 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.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getMaterialLotQueryRead an input allocation in the current tenant; requires warehouse stock read permission
getPlannedDeliveryQuerygetPlannedDelivery; requires plannedDelivery:read