Skip to main content
Anchor to InventoryShipment

InventoryShipment

object

Requires read_inventory_shipments access scope.

Represents an inventory shipment.

Anchor to FieldsFields

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?

Anchor to QueriesQueries

Anchor to inventoryShipmentinventoryShipment
•query

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

Arguments

Anchor to idid
•ID!
required

The ID of the inventory shipment.

Was this section helpful?

Anchor to MutationsMutations

Anchor to inventoryShipmentAddItemsinventoryShipmentAddItems
•mutation

Adds items to an inventory shipment.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory shipment to modify.

Anchor to lineItemslineItems
•[InventoryShipmentLineItemInput!]!
required

The list of line items to add to the inventory shipment.

Anchor to inventoryShipmentCreateinventoryShipmentCreate
•mutation

Adds a draft shipment to an inventory transfer.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Arguments

Anchor to inputinput
•InventoryShipmentCreateInput!
required

The input fields for the inventory shipment.

Anchor to inventoryShipmentCreateInTransitinventoryShipmentCreateInTransit
•mutation

Adds an in-transit shipment to an inventory transfer.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Arguments

Anchor to inputinput
•InventoryShipmentCreateInput!
required

The input fields for the inventory shipment.

Anchor to inventoryShipmentMarkInTransitinventoryShipmentMarkInTransit
•mutation

Marks a draft inventory shipment as in transit.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory shipment to mark in transit.

Anchor to dateShippeddateShipped
•DateTime

The date the shipment was shipped.

Anchor to inventoryShipmentReceiveinventoryShipmentReceive
•mutation

Receive an inventory shipment.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory shipment to receive.

Anchor to lineItemslineItems
•[InventoryShipmentReceiveItemInput!]

The list of receive line items for the inventory shipment.

Anchor to dateReceiveddateReceived
•DateTime

The date the inventory shipment was initially received.

Anchor to bulkReceiveActionbulkReceiveAction
•InventoryShipmentReceiveLineItemReason

The bulk receive action for the inventory shipment.

Anchor to inventoryShipmentRemoveItemsinventoryShipmentRemoveItems
•mutation

Remove items from an inventory shipment.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory shipment to remove items from.

Anchor to lineItemslineItems
•[ID!]!
required

A list of inventory shipment line item ids representing the items to be removed from the shipment.

Anchor to inventoryShipmentSetTrackinginventoryShipmentSetTracking
•mutation

Edits the tracking info on an inventory shipment.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory shipment whose tracking info is being edited.

Anchor to trackingtracking
•InventoryShipmentTrackingInput!
required

The tracking info to edit on the inventory shipment.

Anchor to inventoryShipmentUpdateItemQuantitiesinventoryShipmentUpdateItemQuantities
•mutation

Updates items on an inventory shipment.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory shipment to update item quantities.

Anchor to itemsitems
•[InventoryShipmentUpdateItemQuantitiesInput!]
Default:[]

The list of line items to be updated to the shipment.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?