Choose a version:

inventoryShipments

query

Requires read_inventory_shipments access scope.

Returns a paginated list of InventoryShipment objects.

Supports filtering by barcode (e.g. barcode:"12345"), status (e.g. status:"draft" or status:"in_transit"), and destination (e.g. destination_id:12345).

Anchor to Arguments

InventoryShipmentConnection arguments

•InventoryShipmentConnection

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to barcode •string
Anchor to destination_id •id
Anchor to id •id: Filter by id range.
Anchor to status •string
Anchor to tracking_number •string

Anchor to sortKeysortKey

•InventoryShipmentSortKeys

Default:ID

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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[InventoryShipmentEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[InventoryShipment!]! non-null: A list of nodes that are contained in InventoryShipmentEdge. 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.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?