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 {
  archivedAt: ISO8601DateTime
  conditions: [EvaluatedCondition!]
  createdAt: ISO8601DateTime!
  destDistributionCenterId: String
  destStoreId: String
  effectiveRequestedCarrierService: EcCarrierService
  effectiveRequestedCarrierServiceName: String
  effectiveShippingInformation: ShippingInformation
  effectiveThirdPartyBilling: Boolean
  enrichmentData: JSON
  externalId: String
  externallyManaged: Boolean!
  fulfilledBy: Party!
  fulfilledById: ID!
  fulfillmentInstructions: String
  fulfillmentIntegration: Integration
  fulfillmentIntegrationId: ID
  fulfillmentItems: [FulfillmentItem!]
  fulfillmentNumber: String
  fulfillmentOrderNumber: String
  handlingInstructions: String
  hasCarrierOverride: Boolean! @deprecated
  id: ID!
  labelsEach: Boolean!
  labelsInner: Boolean!
  labelsMaster: Boolean!
  labelsPallet: Boolean!
  labelsPrice: Boolean!
  order: Order!
  orderId: ID!
  requestedCarrierServiceId: String
  requestedCarrierServiceName: String
  requestedCarrierServiceOverridden: Boolean!
  routingAttachments: String
  routingEmail: String
  routingInstructions: String
  routingPortalUrl: String
  routingRequired: Boolean!
  shipments: [OrderShipment!]
  shippingContainers: [ShippingContainer!]
  shippingInformation: ShippingInformation
  shippingInformationOverridden: Boolean!
  state: OrderFulfillmentStateEnum
  thirdPartyBilling: Boolean
  thirdPartyBillingAccount: String
  thirdPartyBillingCountry: String
  thirdPartyBillingOverridden: Boolean!
  thirdPartyBillingZip: String
  timelineEvents: [FulfillmentTimelineEvent!]
  updatedAt: ISO8601DateTime!
  warehouse: Warehouse!
  warehouseId: ID!
  weightBreak: Int
}

Fields

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.destDistributionCenterId ● String scalar common

Destination distribution center ID. Falls back to order-level b2b_data when unset on the fulfillment.

OrderFulfillment.destStoreId ● String scalar common

Destination store ID. Falls back to order-level b2b_data when unset on the fulfillment.

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.enrichmentData ● JSON scalar common

Enrichment data (billing details, labels, instructions) for this fulfillment. Falls back to order-level if not set.

OrderFulfillment.externalId ● String scalar common

OrderFulfillment.externallyManaged ● Boolean! non-null scalar common

True if this fulfillment's authority is owned by an external integration (not locally editable).

OrderFulfillment.fulfilledBy ● Party! non-null object common

OrderFulfillment.fulfilledById ● ID! non-null scalar common

OrderFulfillment.fulfillmentInstructions ● String scalar common

Free-form fulfillment instructions. Alias of handlingInstructions, backed by the same column. Falls back to order-level b2b_data.instructions when unset. Note: handlingInstructions reads the same column but has no fallback.

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 (FO-{order_number}-{index}). Returns truncated UUID format for legacy fulfillments without an index.

OrderFulfillment.fulfillmentOrderNumber ● String scalar common

OrderFulfillment.handlingInstructions ● String scalar common

Handling instructions for this fulfillment. No fallback. Use fulfillmentInstructions for the enrichment fallback behaviour.

OrderFulfillment.hasCarrierOverride ● Boolean! deprecated non-null scalar common

DEPRECATED

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.labelsEach ● Boolean! non-null scalar common

Whether each-level labels are required. Falls back to order-level b2b_data when unset.

OrderFulfillment.labelsInner ● Boolean! non-null scalar common

Whether inner-level labels are required. Falls back to order-level b2b_data when unset.

OrderFulfillment.labelsMaster ● Boolean! non-null scalar common

Whether master-level labels are required. Falls back to order-level b2b_data when unset.

OrderFulfillment.labelsPallet ● Boolean! non-null scalar common

Whether pallet-level labels are required. Falls back to order-level b2b_data when unset.

OrderFulfillment.labelsPrice ● Boolean! non-null scalar common

Whether price labels are required. Falls back to order-level b2b_data when unset.

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.routingAttachments ● String scalar common

Routing attachments reference. Falls back to order-level b2b_data when unset.

OrderFulfillment.routingEmail ● String scalar common

Routing contact email. Falls back to order-level b2b_data when unset.

OrderFulfillment.routingInstructions ● String scalar common

Routing instructions. Falls back to order-level b2b_data when unset.

OrderFulfillment.routingPortalUrl ● String scalar common

Routing portal URL. Falls back to order-level b2b_data when unset.

OrderFulfillment.routingRequired ● Boolean! non-null scalar common

Whether routing is required. Falls back to order-level b2b_data when unset.

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.state ● OrderFulfillmentStateEnum enum orders

The current state of the fulfillment (draft, allocated, sent, shipped).

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.thirdPartyBillingAccount ● String scalar common

Third-party billing account number. Falls back to order-level b2b_data when unset.

OrderFulfillment.thirdPartyBillingCountry ● String scalar common

Third-party billing country. Falls back to order-level b2b_data when unset.

OrderFulfillment.thirdPartyBillingOverridden ● Boolean! non-null scalar common

True if this fulfillment has its own third-party-billing override (not inherited).

OrderFulfillment.thirdPartyBillingZip ● String scalar common

Third-party billing ZIP/postal code. Falls back to order-level b2b_data when unset.

OrderFulfillment.timelineEvents ● [FulfillmentTimelineEvent!] list object orders

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

OrderFulfillment.weightBreak ● Int scalar common

Weight break for the fulfillment. Falls back to order-level b2b_data when unset.

Returned By

allocateFulfillment mutation ● cancelFulfillment mutation ● createDraftFulfillment mutation ● fulfillOrder mutation ● markFulfillmentShipped mutation ● reassignFulfillmentWarehouse mutation ● revertFulfillmentToDraft mutation ● scheduleFulfillment mutation ● sendFulfillment mutation ● splitFulfillmentItems mutation ● updateFulfillmentEnrichmentDetails mutation ● updateFulfillmentHandlingInstructions mutation ● updateFulfillmentItems mutation ● updateFulfillmentRoutingInstructions mutation ● updateFulfillmentShippingInformation mutation ● updateFulfillmentShippingInstructions mutation ● updateFulfillmentSpecialInstructions mutation

Member Of

FulfillmentItem object ● Order object ● OrderShipment object ● ShippingContainer object ● V2Order object

Implemented By

Taskable union