Fulfillment
Requires access scope, access scope, access scope, access scope, access scope or 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 Fields and connectionsFields and connections
- Anchor to createdAtcreated•
At DateTime!non-null The date and time when the fulfillment was created.
- Anchor to deliveredAtdelivered•
At The date that this fulfillment was delivered.
- Anchor to displayStatusdisplay•
Status Human readable display status for this fulfillment.
- Anchor to estimatedDeliveryAtestimated•
Delivery At The estimated date that this fulfillment will arrive.
- Anchor to eventsevents•Fulfillment
Event Connection!non-null The history of events associated with this fulfillment.
- Anchor to fulfillmentLineItemsfulfillment•
Line Items FulfillmentLine Item Connection!non-null List of the fulfillment's line items.
- Anchor to fulfillmentOrdersfulfillment•
Orders FulfillmentOrder Connection!non-null A paginated list of fulfillment orders for the fulfillment.
- •ID!non-null
A globally-unique ID.
- Anchor to inTransitAtin•
Transit At The date and time when the fulfillment went into transit.
- Anchor to legacyResourceIdlegacy•
Resource Id UnsignedInt64!non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to locationlocation•
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 originAddressorigin•
Address 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
field on theobject instead.- Anchor to requiresShippingrequires•
Shipping Boolean!non-null Whether any of the line items in the fulfillment require shipping.
- Anchor to serviceservice•
Fulfillment service associated with the fulfillment.
- Anchor to statusstatus•Fulfillment
Status!non-null The status of the fulfillment.
- Anchor to totalQuantitytotal•
Quantity Int!non-null Sum of all line item quantities for the fulfillment.
- Anchor to trackingInfotracking•
Info [FulfillmentTracking Info!]!non-null Tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.
- Anchor to updatedAtupdated•
At DateTime!non-null The date and time when the fulfillment was last modified.
Anchor to MutationsMutations
- •mutation
Cancels a fulfillment.
- •ID!required
The ID of the fulfillment to be canceled.
Arguments
- Anchor to fulfillmentfulfillment•
The canceled fulfillment.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •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.
- Anchor to fulfillmentfulfillment•Fulfillment
Input!required The input fields used to create a fulfillment from fulfillment orders.
- Anchor to messagemessage•
An optional message for the fulfillment request.
Arguments
- Anchor to fulfillmentfulfillment•
The created fulfillment.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates tracking information for a fulfillment.
- Anchor to fulfillmentIdfulfillment•
Id ID!required The ID of the fulfillment.
- Anchor to notifyCustomernotify•
Customer 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.
- Anchor to trackingInfoInputtracking•
Info Input FulfillmentTracking Input!required The tracking input for the mutation, including tracking URL, number, and company.
Arguments
- Anchor to fulfillmentfulfillment•
The updated fulfillment with tracking information.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
Deprecated mutations
- •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.
- Anchor to fulfillmentfulfillment•Fulfillment
V2Input!required The input fields used to create a fulfillment from fulfillment orders.
- Anchor to messagemessage•
An optional message for the fulfillment request.
Arguments
- Anchor to fulfillmentfulfillment•
The created fulfillment.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates tracking information for a fulfillment.
- Anchor to fulfillmentIdfulfillment•
Id ID!required The ID of the fulfillment.
- Anchor to notifyCustomernotify•
Customer 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.
- Anchor to trackingInfoInputtracking•
Info Input FulfillmentTracking Input!required The tracking input for the mutation, including tracking URL, number, and company.
Arguments
- Anchor to fulfillmentfulfillment•
The updated fulfillment with tracking information.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields