fulfillment
Requires access scope, access scope, access scope, access scope, access scope or access scope.
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, 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.
Arguments
- •ID!required
The ID of the Fulfillment to return.
Anchor to Possible returnsPossible returns
- Anchor to FulfillmentFulfillment•Fulfillment
A shipment of one or more items from an
Order. Tracks whichobjects 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
objects.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 createdAtcreated•Date
At Time! non-null The date and time when the fulfillment was created.
- Anchor to deliveredAtdelivered•Date
At Time The date that this fulfillment was delivered.
- Anchor to displayStatusdisplay•Fulfillment
Status Display Status Human readable display status for this fulfillment.
- Anchor to estimatedDeliveryAtestimated•Date
Delivery At Time 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 firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Fulfillment
Key Event Sort Keys 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.
Arguments
- Anchor to fulfillmentLineItemsfulfillment•Fulfillment
Line Items Line Item Connection! non-null List of the fulfillment's line items.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to fulfillmentOrdersfulfillment•Fulfillment
Orders Order Connection! non-null A paginated list of fulfillment orders for the fulfillment.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- •ID!non-null
A globally-unique ID.
- Anchor to inTransitAtin•Date
Transit At Time The date and time when the fulfillment went into transit.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! 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 originAddressorigin•Fulfillment
Address Origin 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•Boolean!
Shipping non-null Whether any of the line items in the fulfillment require shipping.
- Anchor to serviceservice•Fulfillment
Service Fulfillment service associated with the fulfillment.
- Anchor to statusstatus•Fulfillment
Status! non-null The status of the fulfillment.
- Anchor to totalQuantitytotal•Int!
Quantity non-null Sum of all line item quantities for the fulfillment.
- Anchor to trackingInfotracking•[Fulfillment
Info Tracking Info!]! 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.
Arguments
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the fulfillment was last modified.