OrderFulfillment
This type represents an order fulfillment. An order can have multiple fulfillments, each one associated with a warehouse and a party that fulfilled the order.
type OrderFulfillment {
additionalData: JSON
allocationRequired: Boolean!
archivedAt: ISO8601DateTime
b2bData: JSON!
b2bDataOverridden: Boolean!
blockers: [EvaluatedCondition!]
conditions: [EvaluatedCondition!]
createdAt: ISO8601DateTime!
effectiveIntegration: Integration
effectiveRequestedCarrierService: EcCarrierService
effectiveRequestedCarrierServiceName: String
effectiveShippingInformation: ShippingInformation
externalId: String
externallyShipped: Boolean!
fulfilledBy: Party!
fulfilledById: ID!
fulfillingSystemCanCancel: Boolean
fulfillmentContainers: [FulfillmentContainer!]!
fulfillmentIntegration: Integration
fulfillmentIntegrationId: ID
fulfillmentItems: [FulfillmentItem!]
fulfillmentNumber: String
fulfillmentOrderNumber: String
fulfillmentRule: FulfillmentRule
fulfillmentRuleId: ID
giftMessage: String
hasCarrierOverride: Boolean! @deprecated
id: ID!
instructions: String
itemCounts: OrderFulfillmentItemCounts!
managedBy: FulfillmentManagementEnum
order: Order!
orderId: ID!
requestedCarrierServiceId: String
requestedCarrierServiceName: String
requestedCarrierServiceOverridden: Boolean!
shipments: [OrderShipment!]
shippingContainers: [ShippingContainer!]
shippingInformation: ShippingInformation
shippingInformationOverridden: Boolean!
sourceExternalId: String
state: OrderFulfillmentStateEnum
supplier: SupplySupplier
supplierId: ID
supplierOtherFeesMonetary: MonetaryValue
supplierOtherFeesNote: String
supplierShippingCostMonetary: MonetaryValue
timelineEvents: [FulfillmentTimelineEvent!] @deprecated
updatedAt: ISO8601DateTime!
warehouse: Warehouse!
warehouseId: ID!
}
Fields
OrderFulfillment.additionalData ● JSON scalar common
Free-form JSON blob for fulfillment-level additional data. Replace semantics on write.
OrderFulfillment.allocationRequired ● Boolean! non-null scalar common
True when this fulfillment must be allocated before shipment creation.
OrderFulfillment.archivedAt ● ISO8601DateTime scalar common
Timestamp at which the fulfillment was soft-archived. nil means active.
OrderFulfillment.b2bData ● JSON! non-null scalar common
Effective B2B data for this fulfillment: order B2B data merged with fulfillment-local B2B data.
OrderFulfillment.b2bDataOverridden ● Boolean! non-null scalar common
True if this fulfillment carries its own B2B data override.
OrderFulfillment.blockers ● [EvaluatedCondition!] list object orders
Unmet conditions for this fulfillment's next transition. Empty when nothing blocks it or the fulfillment is terminal.
OrderFulfillment.conditions ● [EvaluatedCondition!] list object orders
Evaluated conditions for this fulfillment's transitions.
OrderFulfillment.createdAt ● ISO8601DateTime! non-null scalar common
OrderFulfillment.effectiveIntegration ● Integration object integrations
The integration that fulfills this fulfillment: its own when assigned, otherwise the warehouse's. Use it to name the system holding the fulfillment; to decide whether it can be cancelled there, read fulfillingSystemCanCancel rather than this integration's capabilities.
OrderFulfillment.effectiveRequestedCarrierService ● EcCarrierService object shipments
Coalesced carrier service: fulfillment's own if set, otherwise the order's.
OrderFulfillment.effectiveRequestedCarrierServiceName ● String scalar common
Coalesced carrier service display name. Prefer this over
effectiveRequestedCarrierService.serviceName for display: it adds a fallback
to the order's raw requested_carrier_service_name column to preserve
Walmart-ingested orders, where the order carries the carrier name as a free
string with no requested_carrier_service_id.
OrderFulfillment.effectiveShippingInformation ● ShippingInformation object orders
Coalesced ship-to: fulfillment's own if set, otherwise the order's.
OrderFulfillment.externalId ● String scalar common
OrderFulfillment.externallyShipped ● Boolean! non-null scalar common
True if an integration is assigned as this fulfillment's service, so Endless does not process it locally. Resolved from the fulfillment's own routing.
OrderFulfillment.fulfilledBy ● Party! non-null object common
The party expected to report shipments, resolved by the same rule as fulfilledById.
OrderFulfillment.fulfilledById ● ID! non-null scalar common
The party expected to report shipments. Source-linked V2 fulfillments use the order source until handoff to a fulfillment integration.
OrderFulfillment.fulfillingSystemCanCancel ● Boolean scalar common
Whether the system holding this fulfillment can be told to cancel it. Null when no integration fulfills it, so nothing outside Endless holds a copy. True when Endless will cancel it there. False when the cancellation has to be requested by hand, which is why retracting needs confirmation and drops the external id. Answers the same question the retraction itself asks, so a declared capability with no action behind it reads as false here too.
OrderFulfillment.fulfillmentContainers ● [FulfillmentContainer!]! non-null object shipments
EC-authored fulfillment containers (cartonization) for this fulfillment. Excludes archived containers.
OrderFulfillment.fulfillmentIntegration ● Integration object integrations
OrderFulfillment.fulfillmentIntegrationId ● ID scalar common
OrderFulfillment.fulfillmentItems ● [FulfillmentItem!] list object orders
OrderFulfillment.fulfillmentNumber ● String scalar common
Human-readable fulfillment identifier ({order_number}-FO-{suffix}). Returns truncated UUID format for legacy fulfillments without a suffix.
OrderFulfillment.fulfillmentOrderNumber ● String scalar common
OrderFulfillment.fulfillmentRule ● FulfillmentRule object orders
The fulfillment rule that governs how this fulfillment is processed, if assigned.
OrderFulfillment.fulfillmentRuleId ● ID scalar common
The ID of the fulfillment rule assigned to this fulfillment, if any.
OrderFulfillment.giftMessage ● String scalar common
Effective gift message for this fulfillment: fulfillment-local gift message if set, otherwise the order gift message.
OrderFulfillment.hasCarrierOverride ● Boolean! deprecated non-null scalar common
Use requestedCarrierServiceOverridden instead. Will be removed in a future release.
True if this fulfillment has its own carrier override (not inherited from the order).
OrderFulfillment.id ● ID! non-null scalar common
OrderFulfillment.instructions ● String scalar common
Effective instructions for this fulfillment: fulfillment-local instructions if set, otherwise the order customer note.
OrderFulfillment.itemCounts ● OrderFulfillmentItemCounts! non-null object orders
Counts for the active line items on this fulfillment order.
OrderFulfillment.managedBy ● FulfillmentManagementEnum enum common
The system managing the fulfillment lifecycle, or null when unclassified.
OrderFulfillment.order ● Order! non-null object orders
OrderFulfillment.orderId ● ID! non-null scalar common
OrderFulfillment.requestedCarrierServiceId ● String scalar common
The fulfillment's own carrier service ID. null means no override — see
effectiveRequestedCarrierService for the coalesced value and
requestedCarrierServiceOverridden for the override flag.
OrderFulfillment.requestedCarrierServiceName ● String scalar common
The fulfillment's own carrier service name. null means no override — see
effectiveRequestedCarrierService for the coalesced value and
requestedCarrierServiceOverridden for the override flag.
OrderFulfillment.requestedCarrierServiceOverridden ● Boolean! non-null scalar common
True if this fulfillment has its own requested carrier service override (not inherited).
OrderFulfillment.shipments ● [OrderShipment!] list object shipments
OrderFulfillment.shippingContainers ● [ShippingContainer!] list object shipments
The shipping containers associated with this fulfillment.
OrderFulfillment.shippingInformation ● ShippingInformation object orders
The fulfillment's own ShippingInformation (override). See effectiveShippingInformation for the coalesced value.
OrderFulfillment.shippingInformationOverridden ● Boolean! non-null scalar common
True if this fulfillment has its own ShippingInformation override (not inherited).
OrderFulfillment.sourceExternalId ● String scalar common
External reference to the source record that created this fulfillment, present when linked to its originating integration.
OrderFulfillment.state ● OrderFulfillmentStateEnum enum orders
The current state of the fulfillment (draft, allocated, ready, in_progress, fulfilled, failed_to_fulfill, canceled).
OrderFulfillment.supplier ● SupplySupplier object suppliers
The supplier assigned to this fulfillment, if any.
OrderFulfillment.supplierId ● ID scalar common
The ID of the supplier assigned to this fulfillment, if any.
OrderFulfillment.supplierOtherFeesMonetary ● MonetaryValue object common
Other fees charged by the supplier for this fulfillment, if recorded.
OrderFulfillment.supplierOtherFeesNote ● String scalar common
Free-text note describing the supplier's other fees, if recorded.
OrderFulfillment.supplierShippingCostMonetary ● MonetaryValue object common
The supplier's shipping/freight charge for this fulfillment, if recorded.
OrderFulfillment.timelineEvents ● [FulfillmentTimelineEvent!] deprecated list object orders
Use systemLogs(filters: { entityId: ..., entityType: ORDER_FULFILLMENT }) instead.
Chronological domain events for this fulfillment.
OrderFulfillment.updatedAt ● ISO8601DateTime! non-null scalar common
OrderFulfillment.warehouse ● Warehouse! non-null object warehouses
OrderFulfillment.warehouseId ● ID! non-null scalar common
Returned By
allocateFulfillment mutation ● archiveFulfillmentContainer mutation ● assignFulfillmentContainerSsccs mutation ● assignFulfillmentRule mutation ● cancelFulfillment mutation ● createDraftFulfillment mutation ● createFulfillmentContainer mutation ● destroyFulfillmentContainer mutation ● fulfillOrder mutation ● markFulfillmentFulfilled mutation ● markFulfillmentInProgress mutation ● markFulfillmentReady mutation ● orderFulfillment query ● reassignFulfillmentWarehouse mutation ● removeFulfillmentRule mutation ● revertFulfillmentToAllocated mutation ● revertFulfillmentToDraft mutation ● scheduleFulfillment mutation ● setFulfillmentContainerRequirements mutation ● setFulfillmentContainersStatus mutation ● setFulfillmentIntegration mutation ● setFulfillmentSupplier mutation ● splitFulfillmentItems mutation ● updateFulfillmentAdditionalData mutation ● updateFulfillmentB2bData mutation ● updateFulfillmentContainer mutation ● updateFulfillmentCosts mutation ● updateFulfillmentDetails mutation ● updateFulfillmentHandlingInstructions mutation ● updateFulfillmentItems mutation ● updateFulfillmentShippingInformation mutation ● updateFulfillmentShippingInstructions mutation
Member Of
FulfillmentItem object ● Order object ● OrderFulfillmentConnection object ● OrderFulfillmentEdge object ● OrderShipment object ● ShippingContainer object ● V2Order object
Implemented By
Taskable union