fulfillmentOrders - admin-graphql - QUERY
Version: 2024-10
Description:
The paginated list of all fulfillment orders.
The returned fulfillment orders are filtered according to the
[fulfillment order access scopes](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder#api-access-scopes)
granted to the app.
Use this query to retrieve fulfillment orders assigned to merchant-managed locations,
third-party fulfillment service locations, or all kinds of locations together.
For fetching only the fulfillment orders assigned to the app's locations, use the
[assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/2024-07/objects/queryroot#connection-assignedfulfillmentorders)
connection.
Access Scopes
`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.
Arguments
-
after:
String -
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
-
before:
String -
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
-
first:
Int -
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
-
includeClosed:
Boolean -
Whether to include closed fulfillment orders.
-
last:
Int -
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
-
query:
String -
A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
| ---- | ---- | ---- | ---- | ---- | ---- |
| default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` |
| assigned_location_id | id |
| id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` |
| status | string |
| updated_at | time |
You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
-
reverse:
Boolean -
Reverse the order of the underlying list.
-
sortKey:
FulfillmentOrderSortKeys -
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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).
Returns
-
edges:
FulfillmentOrderEdge!
The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
-
nodes:
FulfillmentOrder!
A list of nodes that are contained in FulfillmentOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
-
pageInfo:
PageInfo!
An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.
Examples