Fulfillment
Shipping, carriers, warehousing, stock and procurement.
127 operations · complete schema 370 KB
magicQuery
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.
getMagicQuerySchema
Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
listMagicQueries
Lists every available Magic Query noun with a short description and its options — the discovery entry point.
getMagicQueryGraphQL
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.
listDataChangeEventTopics
List all valid data change event topics, grouped by resource. Requires authentication.
generateDefaultDataQuery
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.
ping
Health check endpoint
iacSchema
The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacValidate
Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
iacGuides
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.
helpChapters
List human-facing manual chapters from the running deployment.
helpChapter
Read a chapter of the current published manual edition.
searchHelp
Search human-facing manuals using shared semantic and text retrieval.
schemaAuthoringCatalog
Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
compileSchemaXML
Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
renderSchemaXML
Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
iacSchemaDocument
Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
getWarehouseLocation
Fetch a single warehouse location in the caller's tenant by id; null when no such location exists. Requires warehouseLocation:read permission.
listWarehouseLocations
List the caller's tenant's warehouse locations, filtered and sorted, as a paginated connection. Requires warehouseLocation:list permission.
getWarehouseStock
Fetch a single warehouse stock record in the caller's tenant. Returns null when no such record exists. Requires read access to warehouse stock.
listWarehouseStocks
List the warehouse stock records in the caller's tenant, filtered, sorted and paginated. Requires list access to warehouse stock.
getWarehouseTransfer
Fetch a single warehouse transfer in the caller's tenant, or null when no such transfer exists. Requires warehouseTransfer:read permission.
listWarehouseTransfers
List the warehouse transfers in the caller's tenant as a paginated connection. Requires warehouseTransfer:list permission.
getCarrier
Fetch a carrier by ID. Requires carrier:read permission.
listCarriers
List carriers with pagination. Requires carrier:list permission.
getShipment
Fetch a shipment by ID. Requires shipment:read permission.
listShipments
List shipments with pagination. Requires shipment:list permission.
getShipmentPackage
Fetch a shipment package by ID. Requires shipment:read permission.
listShipmentPackages
List shipment packages with pagination. Requires shipment:list permission.
getShipmentItem
Fetch a shipment item by ID. Requires shipment:read permission.
listShipmentItems
List shipment items with pagination. Requires shipment:list permission.
getPlannedDelivery
getPlannedDelivery; requires plannedDelivery:read
listPlannedDeliveries
listPlannedDeliveries; requires plannedDelivery:list
getPlannedDeliveryItem
getPlannedDeliveryItem; requires plannedDelivery:read
listPlannedDeliveryItems
listPlannedDeliveryItems; requires plannedDelivery:list
getShipmentItemAllocation
getShipmentItemAllocation; requires plannedDelivery:read
listShipmentItemAllocations
listShipmentItemAllocations; requires plannedDelivery:list
getFulfillmentRequirement
getFulfillmentRequirement; tenant-scoped and permission checked
listFulfillmentRequirements
listFulfillmentRequirements; tenant-scoped and permission checked
getCustomerFulfillmentDefault
getCustomerFulfillmentDefault; tenant-scoped and permission checked
listCustomerFulfillmentDefaults
listCustomerFulfillmentDefaults; tenant-scoped and permission checked
effectiveFulfillmentRequirements
Authoritative copied/local requirements and explicit exceptions, with review diagnostics; does not infer execution satisfaction
getShipmentItemEvidence
getShipmentItemEvidence; tenant-scoped evidence without inferred completion
listShipmentItemEvidence
listShipmentItemEvidence; tenant-scoped evidence without inferred completion
shipmentItemExecutionBalance
shipmentItemExecutionBalance; tenant-scoped evidence without inferred completion
plannedItemFulfillmentBalance
plannedItemFulfillmentBalance; tenant-scoped evidence without inferred completion
getRequirementEvidence
getRequirementEvidence; read-only, no inferred completion or macro gate
listRequirementEvidence
listRequirementEvidence; read-only, no inferred completion or macro gate
assessFulfillmentRequirements
assessFulfillmentRequirements; read-only, no inferred completion or macro gate
plannedItemReview
Review a planned item using shared balances, effective requirements, assessment and authorized notes
orderFulfillmentCompletion
Assess current policy across every order line using explicitly attributed quantities
getEntityNote
Read operational notes with current target permissions
getEntityNoteBySource
Read operational notes with current target permissions
entityNotes
Read operational notes with current target permissions
searchEntityNotes
Read operational notes with current target permissions
getJobMaterialReservation
Fetch a single job material reservation by ID. Requires jobMaterialReservation:read permission.
listJobMaterialReservations
List material reservations with pagination. Requires jobMaterialReservation:list permission.
dailyDispatchManifest
Fetch all shipments for a given date with packages, items, and order details. Requires shipment:list.
fulfillmentTrace
Lineage subgraph (nodes + edges) around a fulfillment entity. Requires fulfillment:read permission.
fulfillmentImpact
Entities reachable up/downstream from a fulfillment entity (the seed is excluded). Requires fulfillment:read permission.
provenanceTrace
Cross-layer lineage subgraph (nodes + edges) around a provenance entity, over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
provenanceImpact
Entities reachable up/downstream from a provenance entity (the seed is excluded), over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
whatIf
First-class hypothetical impact: the delta between the baseline reachable set from seeds and the reachable set with extraEdges unioned in, plus whether the injected edges introduce a cycle. Requires provenance:read permission.
createWarehouseLocation
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.
updateWarehouseLocation
Apply a partial update to an existing warehouse location and emit an updated event. Returns an error payload when the id is unknown in the caller's tenant or the result fails validation. Requires warehouseLocation:write permission.
upsertWarehouseLocation
Create or fully replace a warehouse location by id, preserving the original createdAt when it already exists, and emit an updated event. Because the whole state is written, omitted optional fields are reset to their defaults. Requires warehouseLocation:write permission.
deleteWarehouseLocation
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.
upsertWarehouseStock
Create or wholesale-replace a warehouse stock record in the caller's tenant: creates one when `input.id` is omitted or unknown, otherwise overwrites the existing record. Emits a warehouse-stock updated event. Requires write access to warehouse stock.
createWarehouseStock
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.
updateWarehouseStock
Patch an existing warehouse stock record in the caller's tenant. Returns an `id` error when the record does not exist, or validation errors when the patched quantities are invalid. Emits a warehouse-stock updated event. Requires write access to warehouse stock.
deleteWarehouseStock
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.
upsertWarehouseTransfer
Create a warehouse transfer, or wholly replace an existing one when input.id is supplied. Returns validation errors instead of saving when source and destination match or quantity is not positive. Requires warehouseTransfer:write permission.
createWarehouseTransfer
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.
updateWarehouseTransfer
Apply a partial update to an existing warehouse transfer. Returns an error payload when the transfer does not exist, and validation errors when the result would have a matching source and destination or a non-positive quantity. Requires warehouseTransfer:write permission.
deleteWarehouseTransfer
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.
upsertCarrier
Create or update a carrier. Requires carrier:write permission.
createCarrier
Create a new carrier. Requires carrier:write permission.
updateCarrier
Update a carrier. Only provided fields are changed. Requires carrier:write permission.
deleteCarrier
Delete a carrier. Requires carrier:delete permission.
upsertShipment
Create or update a shipment. Requires shipment:write permission.
createShipment
Create a new shipment. Requires shipment:write permission.
updateShipment
Update a shipment. Only provided fields are changed. Requires shipment:write permission.
deleteShipment
Delete a shipment. Requires shipment:delete permission.
createShipmentPackage
Create a new shipment package. Requires shipment:write permission.
updateShipmentPackage
Update a shipment package. Only provided fields are changed. Requires shipment:write permission.
upsertShipmentPackage
Create or update a shipment package. Requires shipment:write permission.
deleteShipmentPackage
Delete a shipment package. Requires shipment:delete permission.
upsertShipmentItem
Create or update a shipment item. Requires shipment:write permission.
createShipmentItem
Create a new shipment item. Requires shipment:write permission.
updateShipmentItem
Update a shipment item. Only provided fields are changed. Requires shipment:write permission.
deleteShipmentItem
Delete a shipment item. Requires shipment:delete permission.
createPlannedDelivery
createPlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:write
updatePlannedDelivery
updatePlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:write
deletePlannedDelivery
deletePlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:delete
createPlannedDeliveryItem
createPlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:write
updatePlannedDeliveryItem
updatePlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:write
deletePlannedDeliveryItem
deletePlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:delete
createShipmentItemAllocation
createShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:write and shipment:write
updateShipmentItemAllocation
updateShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:write and shipment:write
deleteShipmentItemAllocation
deleteShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:delete and shipment:write
createFulfillmentRequirement
createFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects
createCustomerFulfillmentDefault
createCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
updateCustomerFulfillmentDefault
updateCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
retireFulfillmentRequirement
retireFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects
retireCustomerFulfillmentDefault
retireCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
resolveCustomerFulfillmentDefaults
resolveCustomerFulfillmentDefaults; explicit structural operation, no lifecycle gating or execution side effects
recordShipmentItemEvidence
recordShipmentItemEvidence; validates structure and permissions without lifecycle gating
attributeShipmentItemEvidence
attributeShipmentItemEvidence; validates structure and permissions without lifecycle gating
recordRequirementEvidence
Records evidence without running approvals, sending messages or enforcing lifecycle rules
updateFulfillmentSettings
Save only the fulfillment section, preserving every other settings section
completeOrderFulfillment
Explicitly complete an order when all its planned quantities satisfy the current milestone; never fabricate delivery or reopen completed work
createEntityNote
Save note changes independently of embedding success
updateEntityNote
Save note changes independently of embedding success
deleteEntityNote
Save note changes independently of embedding success
reindexEntityNotes
Queue bounded recoverable indexing work using the current model
upsertJobMaterialReservation
Create or update a job material reservation. Requires jobMaterialReservation:write permission.
createJobMaterialReservation
Create a new job material reservation. Requires jobMaterialReservation:write permission.
updateJobMaterialReservation
Update a job material reservation. Only provided fields are changed. Requires jobMaterialReservation:write permission.
deleteJobMaterialReservation
Delete a job material reservation. Requires jobMaterialReservation:delete permission.
reserveJobMaterials
Attempt to reserve warehouse stock for all pending material reservations on a job. Requires jobMaterialReservation:write permission.
dispatchShipment
Create a shipment with packages and items, marking it as picked up. Requires shipment:write.
updateShipmentTracking
Update shipment status and tracking details. Requires shipment:write.
createPurchaseOrder
Create a purchase order with lines, computing totals automatically. Requires purchaseOrder:write.
receivePurchaseOrder
Record receipt of purchase order lines, optionally adding to warehouse stock. Requires purchaseOrder:write.
issueStockToProduction
Issue warehouse stock to production, creating transfers and reducing quantities. Requires warehouseStock:write.
performStockCount
Perform a stock count, adjusting quantities and recording differences. Requires warehouseStock:write.
dataChangeEvents
Subscribe to real-time data change events. Requires read permission on each requested resource.