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
archivedAt: ISO8601DateTime
conditions: [EvaluatedCondition!]
createdAt: ISO8601DateTime!
effectiveRequestedCarrierService: EcCarrierService
effectiveRequestedCarrierServiceName: String
effectiveShippingInformation: ShippingInformation
effectiveThirdPartyBilling: Boolean
externalId: String
externallyManaged: Boolean!
fulfilledBy: Party!
fulfilledById: ID!
fulfillmentIntegration: Integration
fulfillmentIntegrationId: ID
fulfillmentItems: [FulfillmentItem!]
fulfillmentNumber: String
fulfillmentOrderNumber: String
fulfillmentProfile: FulfillmentProfile
fulfillmentProfileId: ID
giftMessage: String
handlingInstructions: String
hasCarrierOverride: Boolean! @deprecated
id: ID!
instructions: String
order: Order!
orderId: ID!
requestedCarrierServiceId: String
requestedCarrierServiceName: String
requestedCarrierServiceOverridden: Boolean!
shipments: [OrderShipment!]
shippingContainers: [ShippingContainer!]
shippingInformation: ShippingInformation
shippingInformationOverridden: Boolean!
sourceExternalId: String
state: OrderFulfillmentStateEnum
thirdPartyBilling: Boolean
thirdPartyBillingOverridden: Boolean!
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.archivedAt ● ISO8601DateTime scalar common
Timestamp at which the fulfillment was soft-archived. nil means active.
OrderFulfillment.conditions ● [EvaluatedCondition!] list object orders
Evaluated conditions for this fulfillment's transitions.
OrderFulfillment.createdAt ● ISO8601DateTime! non-null scalar common
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.effectiveThirdPartyBilling ● Boolean scalar common
Coalesced third-party-billing: fulfillment's own value if non-nil, otherwise the order's.
OrderFulfillment.externalId ● String scalar common
OrderFulfillment.externallyManaged ● Boolean! non-null scalar common
True if the order is owned by an external integration (not locally editable).
OrderFulfillment.fulfilledBy ● Party! non-null object common
OrderFulfillment.fulfilledById ● ID! non-null scalar common
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.fulfillmentProfile ● FulfillmentProfile object orders
The profile that governs how this fulfillment is processed, if assigned.
OrderFulfillment.fulfillmentProfileId ● ID scalar common
The ID of the profile assigned to this fulfillment, if any.
OrderFulfillment.giftMessage ● String scalar common
Gift message to send with this fulfillment.
OrderFulfillment.handlingInstructions ● String scalar common
Handling instructions for this fulfillment.
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
Fulfillment-facing free-text instructions for processing this fulfillment.
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, cancelled).
OrderFulfillment.thirdPartyBilling ● Boolean scalar common
The fulfillment's own third-party-billing flag. null means no override — see
effectiveThirdPartyBilling for the coalesced value and
thirdPartyBillingOverridden for the override flag.
OrderFulfillment.thirdPartyBillingOverridden ● Boolean! non-null scalar common
True if this fulfillment has its own third-party-billing override (not inherited).
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 ● assignFulfillmentProfile mutation ● cancelFulfillment mutation ● createDraftFulfillment mutation ● fulfillOrder mutation ● markFulfillmentFulfilled mutation ● markFulfillmentInProgress mutation ● markFulfillmentReady mutation ● orderFulfillment query ● reassignFulfillmentWarehouse mutation ● removeFulfillmentProfile mutation ● revertFulfillmentToAllocated mutation ● revertFulfillmentToDraft mutation ● scheduleFulfillment mutation ● splitFulfillmentItems mutation ● updateFulfillmentAdditionalData 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