Choose a version:

Fulfillment

object

Requires read_orders access scope, read_marketplace_orders access scope, read_assigned_fulfillment_orders access scope, read_merchant_managed_fulfillment_orders access scope, read_third_party_fulfillment_orders access scope or read_marketplace_fulfillment_orders access scope.

A shipment of one or more items from an Order. Tracks which LineItem objects ship, their quantities, and the shipment's tracking information.

Includes tracking details such as the carrier, tracking numbers, and URLs. The fulfillment connects to both the original order and any associated FulfillmentOrder objects. FulfillmentEvent objects record milestones throughout the shipment lifecycle, from creation through delivery.

Multiple fulfillments can exist for a single order when items either ship separately or from different locations.

Anchor to FieldsFields

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time when the fulfillment was created.

Anchor to deliveredAtdeliveredAt

•DateTime

The date that this fulfillment was delivered.

Anchor to displayStatusdisplayStatus

•FulfillmentDisplayStatus

Human readable display status for this fulfillment.

Anchor to estimatedDeliveryAtestimatedDeliveryAt

•DateTime

The estimated date that this fulfillment will arrive.

Anchor to eventsevents

•FulfillmentEventConnection!

non-null

The history of events associated with this fulfillment.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•FulfillmentEventSortKeys

Default:HAPPENED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to fulfillmentLineItemsfulfillmentLineItems

•FulfillmentLineItemConnection!

non-null

List of the fulfillment's line items.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to fulfillmentOrdersfulfillmentOrders

•FulfillmentOrderConnection!

non-null

A paginated list of fulfillment orders for the fulfillment.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to inTransitAtinTransitAt

•DateTime

The date and time when the fulfillment went into transit.

Anchor to legacyResourceIdlegacyResourceId

•UnsignedInt64!

non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to locationlocation

•Location

The location that the fulfillment was processed at.

Anchor to namename

•String!

non-null

Human readable reference identifier for this fulfillment.

Anchor to orderorder

•Order!

non-null

The order for which the fulfillment was created.

Anchor to originAddressoriginAddress

•FulfillmentOriginAddress

The address at which the fulfillment occurred. This field is intended for tax purposes, as a full address is required for tax providers to accurately calculate taxes. Typically this is the address of the warehouse or fulfillment center. To retrieve a fulfillment location's address, use the assignedLocation field on the FulfillmentOrder object instead.

Anchor to requiresShippingrequiresShipping

•Boolean!

non-null

Whether any of the line items in the fulfillment require shipping.

Anchor to serviceservice

•FulfillmentService

Fulfillment service associated with the fulfillment.

Anchor to statusstatus

•FulfillmentStatus!

non-null

The status of the fulfillment.

Anchor to totalQuantitytotalQuantity

•Int!

non-null

Sum of all line item quantities for the fulfillment.

Anchor to trackingInfotrackingInfo

•[FulfillmentTrackingInfo!]!

non-null

Tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.

Anchor to firstfirst •Int: Truncate the array result to this size.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time when the fulfillment was last modified.

Was this section helpful?

Anchor to QueriesQueries

Anchor to fulfillment fulfillment

•query

Retrieves a Fulfillment by its ID. A fulfillment is a record that the merchant has completed their work required for one or more line items in an Order. It includes tracking information, LineItem objects, and the status of the fulfillment.

Use this query to track the progress of shipped items, view tracking details, or check fulfillment events for example when a package is out for delivery or delivered.

Anchor to idid •ID! required: The ID of the Fulfillment to return.

Was this section helpful?

Anchor to MutationsMutations

Anchor to fulfillmentCancel fulfillmentCancel

•mutation

Cancels an existing Fulfillment and reverses its effects on associated FulfillmentOrder objects. When you cancel a fulfillment, the system creates new fulfillment orders for the cancelled items so they can be fulfilled again.

The cancellation affects fulfillment orders differently based on their fulfillment status. If a fulfillment order was entirely fulfilled, then it automatically closes. If a fulfillment order is partially fulfilled, then the remaining quantities adjust to include the cancelled items. The system creates new fulfillment orders at the original Location when items are still stocked there, or at alternative locations based on the store's fulfillment priority settings.

Learn more about canceling fulfillments.

Anchor to idid •ID! required: The ID of the fulfillment to be canceled.

Anchor to fulfillmentCreate fulfillmentCreate

•mutation

Creates a fulfillment for one or more FulfillmentOrder objects. The fulfillment orders are associated with the same Order and are assigned to the same Location.

Use this mutation to mark items as fulfilled when they're ready to ship. You can specify tracking information, customer notification preferences, and which FulfillmentOrderLineItem objects to fulfill from each fulfillment order. If you don't specify line items, then the mutation fulfills all items in the fulfillment order.

Learn more about building fulfillment solutions.

Arguments

Anchor to fulfillmentfulfillment

•FulfillmentInput!

required

The input fields used to create a fulfillment from fulfillment orders.

Anchor to messagemessage

•String

An optional message for the fulfillment request.

Anchor to fulfillmentTrackingInfoUpdate fulfillmentTrackingInfoUpdate

•mutation

Updates tracking information for a fulfillment, including the carrier name, tracking numbers, and tracking URLs. You can provide either single or multiple tracking numbers for shipments with multiple packages.

The mutation accepts a FulfillmentTrackingInput that supports both single tracking (using number and url fields) and multi-package tracking (using numbers and urls fields). When you specify a supported carrier name, Shopify automatically generates tracking URLs for the provided tracking numbers.

You can optionally notify customers about tracking updates with the notifyCustomer argument. When enabled, customers receive shipping update emails with tracking details and receive notifications about future updates to the fulfillment.

Learn more about enabling tracking support for fulfillment services.

Arguments

Anchor to fulfillmentIdfulfillmentId

•ID!

required

The ID of the fulfillment.

Anchor to trackingInfoInputtrackingInfoInput

•FulfillmentTrackingInput!

required

The tracking input for the mutation, including tracking URL, number, and company.

Anchor to notifyCustomernotifyCustomer

•Boolean

Whether the customer will be notified of this update and future updates for the fulfillment. If this field is left blank, then notifications won't be sent to the customer when the fulfillment is updated.