# Fulfillment Shipping, carriers, warehousing, stock and procurement. ## Operations ```graphql # Fulfillment (fulfillment) # Shipping, carriers, warehousing, stock and procurement. # Query assessFulfillmentRequirements: FulfillmentRequirementAssessment! # assessFulfillmentRequirements; read-only, no inferred completion or macro gate compileSchemaXML: String! # Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded dailyDispatchManifest: DailyDispatchManifestPayload! # Fetch all shipments for a given date with packages, items, and order details effectiveFulfillmentRequirements: FulfillmentRequirementComposition! # Authoritative copied/local requirements and explicit exceptions, with review diagnostics; does not infer execution satisfaction entityNotes: EntityNotePage! # Read operational notes with current target permissions fulfillmentImpact: [GraphNode!]! # Entities reachable up/downstream from a fulfillment entity (the seed is excluded) fulfillmentTrace: GraphTrace! # Lineage subgraph (nodes + edges) around a fulfillment entity generateDefaultDataQuery: String # Generate a default GraphQL data query for an event topic getCarrier: CarrierState # Fetch a carrier by ID getCustomerFulfillmentDefault: CustomerFulfillmentDefault # getCustomerFulfillmentDefault; tenant-scoped and permission checked getEntityNote: EntityNote # Read operational notes with current target permissions getEntityNoteBySource: EntityNote # Read operational notes with current target permissions getFulfillmentRequirement: FulfillmentRequirement # getFulfillmentRequirement; tenant-scoped and permission checked getJobMaterialReservation: JobMaterialReservationState # Fetch a single job material reservation by ID getMagicQueryGraphQL: MagicQueryOperation! # 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 getMagicQuerySchema: MagicQuerySchema! # Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery getPlannedDelivery: PlannedDeliveryState # getPlannedDelivery; requires plannedDelivery:read getPlannedDeliveryItem: PlannedDeliveryItemState # getPlannedDeliveryItem; requires plannedDelivery:read getRequirementEvidence: RequirementEvidence # getRequirementEvidence; read-only, no inferred completion or macro gate getShipment: ShipmentState # Fetch a shipment by ID getShipmentItem: ShipmentItemState # Fetch a shipment item by ID getShipmentItemAllocation: ShipmentItemAllocationState # getShipmentItemAllocation; requires plannedDelivery:read getShipmentItemEvidence: ShipmentItemEvidence # getShipmentItemEvidence; tenant-scoped evidence without inferred completion getShipmentPackage: ShipmentPackageState # Fetch a shipment package by ID getWarehouseLocation: WarehouseLocationState # Fetch a single warehouse location in the caller's tenant by id; null when no such location exists getWarehouseStock: WarehouseStockState # Fetch a single warehouse stock record in the caller's tenant getWarehouseTransfer: WarehouseTransferState # Fetch a single warehouse transfer in the caller's tenant, or null when no such transfer exists helpChapter: HelpChapter # Read a chapter of the current published manual edition helpChapters: [HelpChapterInfo!]! # List human-facing manual chapters from the running deployment iacGuides: [IaCGuide!]! # Every authoring guide, for a tool that syncs them to a folder iacSchema: IaCSchemaDocument! # The infrastructure-only view of this schema, for declarative tooling iacSchemaDocument: IaCSchemaDocumentPayload! # Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling iacValidate: IaCValidationResult! # Validate an infrastructure artifact listCarriers: CarrierConnection! # List carriers with pagination listCustomerFulfillmentDefaults: CustomerFulfillmentDefaultConnection! # listCustomerFulfillmentDefaults; tenant-scoped and permission checked listDataChangeEventTopics: [DataChangeEventGroup!]! # List all valid data change event topics, grouped by resource listFulfillmentRequirements: FulfillmentRequirementConnection! # listFulfillmentRequirements; tenant-scoped and permission checked listJobMaterialReservations: JobMaterialReservationConnection! # List material reservations with pagination listMagicQueries: [MagicQueryInfo!]! # Lists every available Magic Query noun with a short description and its options — the discovery entry point listPlannedDeliveries: PlannedDeliveryConnection! # listPlannedDeliveries; requires plannedDelivery:list listPlannedDeliveryItems: PlannedDeliveryItemConnection! # listPlannedDeliveryItems; requires plannedDelivery:list listRequirementEvidence: RequirementEvidenceConnection! # listRequirementEvidence; read-only, no inferred completion or macro gate listShipmentItemAllocations: ShipmentItemAllocationConnection! # listShipmentItemAllocations; requires plannedDelivery:list listShipmentItemEvidence: ShipmentItemEvidenceConnection! # listShipmentItemEvidence; tenant-scoped evidence without inferred completion listShipmentItems: ShipmentItemConnection! # List shipment items with pagination listShipmentPackages: ShipmentPackageConnection! # List shipment packages with pagination listShipments: ShipmentConnection! # List shipments with pagination listWarehouseLocations: WarehouseLocationConnection! # List the caller's tenant's warehouse locations, filtered and sorted, as a paginated connection listWarehouseStocks: WarehouseStockConnection! # List the warehouse stock records in the caller's tenant, filtered, sorted and paginated listWarehouseTransfers: WarehouseTransferConnection! # List the warehouse transfers in the caller's tenant as a paginated connection magicQuery: JSON! # Executes a Magic Query string and returns the predefined query's JSON result orderFulfillmentCompletion: OrderFulfillmentCompletion! # Assess current policy across every order line using explicitly attributed quantities ping: String! # Health check endpoint plannedItemFulfillmentBalance: PlannedItemFulfillmentBalance! # plannedItemFulfillmentBalance; tenant-scoped evidence without inferred completion plannedItemReview: PlannedItemReview! # Review a planned item using shared balances, effective requirements, assessment and authorized notes provenanceImpact: [GraphNode!]! # Entities reachable up/downstream from a provenance entity (the seed is excluded), over the structural composite (operational + fulfillment + provenance) provenanceTrace: GraphTrace! # Cross-layer lineage subgraph (nodes + edges) around a provenance entity, over the structural composite (operational + fulfillment + provenance) renderSchemaXML: String! # Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document schemaAuthoringCatalog: JSON! # Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations searchEntityNotes: EntityNoteSearchPage! # Read operational notes with current target permissions searchHelp: HelpSearchResult! # Search human-facing manuals using shared semantic and text retrieval shipmentItemExecutionBalance: ShipmentItemExecutionBalance! # shipmentItemExecutionBalance; tenant-scoped evidence without inferred completion whatIf: WhatIfResult! # 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 # Mutation attributeShipmentItemEvidence: ShipmentItemEvidencePayload! # attributeShipmentItemEvidence; validates structure and permissions without lifecycle gating completeOrderFulfillment: UpsertOrderPayload! # Explicitly complete an order when all its planned quantities satisfy the current milestone; never fabricate delivery or reopen completed work createCarrier: UpsertCarrierPayload! # Create a new carrier createCustomerFulfillmentDefault: CustomerFulfillmentDefaultPayload! # createCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects createEntityNote: EntityNotePayload! # Save note changes independently of embedding success createFulfillmentRequirement: FulfillmentRequirementPayload! # createFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects createJobMaterialReservation: UpsertJobMaterialReservationPayload! # Create a new job material reservation createPlannedDelivery: PlannedDeliveryPayload! # createPlannedDelivery; structural validation only, no lifecycle gates createPlannedDeliveryItem: PlannedDeliveryItemPayload! # createPlannedDeliveryItem; structural validation only, no lifecycle gates createPurchaseOrder: CreatePurchaseOrderPayload! # Create a purchase order with lines, computing totals automatically createShipment: UpsertShipmentPayload! # Create a new shipment createShipmentItem: UpsertShipmentItemPayload! # Create a new shipment item createShipmentItemAllocation: ShipmentItemAllocationPayload! # createShipmentItemAllocation; structural validation only, no lifecycle gates createShipmentPackage: UpsertShipmentPackagePayload! # Create a new shipment package createWarehouseLocation: WarehouseLocationPayload! # Create a warehouse location in the caller's tenant and emit a created event createWarehouseStock: WarehouseStockPayload! # Create a warehouse stock record in the caller's tenant with a server-assigned WarehouseStock TypeID createWarehouseTransfer: WarehouseTransferPayload! # Create a warehouse transfer in the caller's tenant deleteCarrier: DeletePayload! # Delete a carrier deleteEntityNote: DeletePayload! # Save note changes independently of embedding success deleteJobMaterialReservation: DeletePayload! # Delete a job material reservation deletePlannedDelivery: DeletePayload! # deletePlannedDelivery; structural validation only, no lifecycle gates deletePlannedDeliveryItem: DeletePayload! # deletePlannedDeliveryItem; structural validation only, no lifecycle gates deleteShipment: DeletePayload! # Delete a shipment deleteShipmentItem: DeletePayload! # Delete a shipment item deleteShipmentItemAllocation: DeletePayload! # deleteShipmentItemAllocation; structural validation only, no lifecycle gates deleteShipmentPackage: DeletePayload! # Delete a shipment package deleteWarehouseLocation: DeletePayload! # Delete a warehouse location from the caller's tenant and emit a deleted event deleteWarehouseStock: DeletePayload! # Permanently delete a warehouse stock record from the caller's tenant deleteWarehouseTransfer: DeletePayload! # Permanently delete a warehouse transfer from the caller's tenant dispatchShipment: DispatchShipmentPayload! # Create a shipment with packages and items, marking it as picked up issueStockToProduction: IssueStockToProductionPayload! # Issue warehouse stock to production, creating transfers and reducing quantities performStockCount: PerformStockCountPayload! # Perform a stock count, adjusting quantities and recording differences receivePurchaseOrder: ReceivePurchaseOrderPayload! # Record receipt of purchase order lines, optionally adding to warehouse stock recordRequirementEvidence: RequirementEvidencePayload! # Records evidence without running approvals, sending messages or enforcing lifecycle rules recordShipmentItemEvidence: ShipmentItemEvidencePayload! # recordShipmentItemEvidence; validates structure and permissions without lifecycle gating reindexEntityNotes: EntityNoteReindexResult! # Queue bounded recoverable indexing work using the current model reserveJobMaterials: ReserveJobMaterialsPayload! # Attempt to reserve warehouse stock for all pending material reservations on a job resolveCustomerFulfillmentDefaults: PlannedDeliveryPayload! # resolveCustomerFulfillmentDefaults; explicit structural operation, no lifecycle gating or execution side effects retireCustomerFulfillmentDefault: CustomerFulfillmentDefaultPayload! # retireCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects retireFulfillmentRequirement: FulfillmentRequirementPayload! # retireFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects updateCarrier: UpsertCarrierPayload! # Update a carrier updateCustomerFulfillmentDefault: CustomerFulfillmentDefaultPayload! # updateCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects updateEntityNote: EntityNotePayload! # Save note changes independently of embedding success updateFulfillmentSettings: UpdateFulfillmentSettingsPayload! # Save only the fulfillment section, preserving every other settings section updateJobMaterialReservation: UpsertJobMaterialReservationPayload! # Update a job material reservation updatePlannedDelivery: PlannedDeliveryPayload! # updatePlannedDelivery; structural validation only, no lifecycle gates updatePlannedDeliveryItem: PlannedDeliveryItemPayload! # updatePlannedDeliveryItem; structural validation only, no lifecycle gates updateShipment: UpsertShipmentPayload! # Update a shipment updateShipmentItem: UpsertShipmentItemPayload! # Update a shipment item updateShipmentItemAllocation: ShipmentItemAllocationPayload! # updateShipmentItemAllocation; structural validation only, no lifecycle gates updateShipmentPackage: UpsertShipmentPackagePayload! # Update a shipment package updateShipmentTracking: UpdateShipmentTrackingPayload! # Update shipment status and tracking details updateWarehouseLocation: WarehouseLocationPayload! # Apply a partial update to an existing warehouse location and emit an updated event updateWarehouseStock: WarehouseStockPayload! # Patch an existing warehouse stock record in the caller's tenant updateWarehouseTransfer: WarehouseTransferPayload! # Apply a partial update to an existing warehouse transfer upsertCarrier: UpsertCarrierPayload! # Create or update a carrier upsertJobMaterialReservation: UpsertJobMaterialReservationPayload! # Create or update a job material reservation upsertShipment: UpsertShipmentPayload! # Create or update a shipment upsertShipmentItem: UpsertShipmentItemPayload! # Create or update a shipment item upsertShipmentPackage: UpsertShipmentPackagePayload! # Create or update a shipment package upsertWarehouseLocation: WarehouseLocationPayload! # Create or fully replace a warehouse location by id, preserving the original createdAt when it already exists, and emit an updated event upsertWarehouseStock: WarehouseStockPayload! # Create or wholesale-replace a warehouse stock record in the caller's tenant: creates one when `input upsertWarehouseTransfer: WarehouseTransferPayload! # Create a warehouse transfer, or wholly replace an existing one when input # Subscription dataChangeEvents: DataChangeEvent! # Subscribe to real-time data change events # Call describe_operation(name) for arguments and input types. ``` ## Exact schema Download [complete SDL](/schemas/fulfillment.graphql) (378513 bytes). Use the SDL to validate operations; the digest omits argument signatures. ## Guides - [Suppliers and purchase orders](/docs/data-model/erp#suppliers-and-purchase-orders) - [Receive and count warehouse stock](/docs/data-model/logistics#receive-and-count-warehouse-stock) - [Supply materials to a printing job](/docs/data-model/logistics#supply-materials-to-a-printing-job) - [Plan the customer delivery](/docs/data-model/logistics#plan-the-customer-delivery) - [Record delivery requirements](/docs/data-model/logistics#record-delivery-requirements) - [Prepare shipments and packages](/docs/data-model/logistics#prepare-shipments-and-packages) - [Record dispatch, receipt and returns](/docs/data-model/logistics#record-dispatch-receipt-and-returns) - [Review fulfilment and complete the order](/docs/data-model/logistics#review-fulfilment-and-complete-the-order) - [Warehousing and Logistics API reference](/docs/data-model/logistics-reference) - [ERP API reference](/docs/data-model/erp-reference) - [Read locations and carriers](/docs/data-model/logistics#read-locations-and-carriers)