Skip to main content
Anchor to Fulfillment

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.

Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order.

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.

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 fulfillmentOrdersfulfillmentOrders
•FulfillmentOrderConnection!
non-null

A paginated list of fulfillment orders for the 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 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.

Arguments

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 fulfillmentfulfillment
•query

Returns a Fulfillment resource by ID.

Arguments

Anchor to idid
•ID!
required

The ID of the Fulfillment to return.

Was this section helpful?

Anchor to MutationsMutations

Anchor to fulfillmentCancelfulfillmentCancel
•mutation

Cancels a fulfillment.

Arguments

Anchor to idid
•ID!
required

The ID of the fulfillment to be canceled.

Anchor to fulfillmentCreatefulfillmentCreate
•mutation

Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.

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 fulfillmentTrackingInfoUpdatefulfillmentTrackingInfoUpdate
•mutation

Updates tracking information for a fulfillment.

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.

Deprecated mutations

Anchor to fulfillmentCreateV2fulfillmentCreateV2
•mutation
Deprecated

Arguments

Anchor to fulfillmentfulfillment
•FulfillmentV2Input!
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 fulfillmentTrackingInfoUpdateV2fulfillmentTrackingInfoUpdateV2
•mutation
Deprecated

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.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?