Skip to main content
Anchor to inventoryShipment

inventoryShipment

query

Requires read_inventory_shipments access scope. Also: The user must have permission to view products.

Retrieves an InventoryShipment by ID. Returns tracking details, InventoryShipmentLineItem objects with quantities, and the shipment's current InventoryShipmentStatus.

Anchor to Arguments

Arguments

Anchor to idid
•ID!
required

The ID of the inventory shipment.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to InventoryShipmentInventoryShipment
•InventoryShipment

Represents an inventory shipment.

Anchor to dateCreateddateCreated
•DateTime

The date the shipment was created in UTC.

Anchor to dateReceiveddateReceived
•DateTime

The date the shipment was initially received in UTC.

Anchor to dateShippeddateShipped
•DateTime

The date the shipment was shipped in UTC.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to lineItemslineItems
•InventoryShipmentLineItemConnection

The line items included in this shipment.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•ShipmentLineItemSortKeys
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.

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 default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to lineItemsCountlineItemsCount
•Count

The number of line items associated with the inventory shipment. Limited to a maximum of 10000 by default.

Arguments

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 default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to limitlimit
•Int
Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to lineItemTotalQuantitylineItemTotalQuantity
•Int!
non-null

The total quantity of all items in the shipment.

Anchor to namename
•String!
non-null

The name of the inventory shipment.

Anchor to statusstatus
•InventoryShipmentStatus!
non-null

The current status of the shipment.

Anchor to totalAcceptedQuantitytotalAcceptedQuantity
•Int!
non-null

The total quantity of items accepted across all line items in this shipment.

Anchor to totalReceivedQuantitytotalReceivedQuantity
•Int!
non-null

The total quantity of items received (both accepted and rejected) across all line items in this shipment.

Anchor to totalRejectedQuantitytotalRejectedQuantity
•Int!
non-null

The total quantity of items rejected across all line items in this shipment.

Anchor to trackingtracking
•InventoryShipmentTracking

The tracking information for the shipment.

Was this section helpful?