Skip to main content
Anchor to InventoryShipmentConnection

InventoryShipmentConnection

connection

An auto-generated type for paginating through multiple InventoryShipments.

Anchor to Fields with this connectionFields with this connection

•OBJECT

Tracks the movement of InventoryItem objects between Location objects. A transfer includes origin and destination information, InventoryTransferLineItem objects with quantities, and shipment details.

Transfers progress through multiple statuses. The transfer maintains LocationSnapshot objects of location details to preserve historical data even if locations change or are deleted later.


Was this section helpful?

Anchor to Queries with this connectionQueries with this connection

•query

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).

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•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.

•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
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
•string
Anchor to tracking_number
•string


Was this section helpful?

•[InventoryShipmentEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

•[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.

•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.


Was this section helpful?