Choose a version:

inventoryShipmentReceive

mutation

Requires write_inventory_shipments_received_items access scope. Also: The user must have permission to manage inventory.

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.

Anchor to Arguments

Arguments

Anchor to bulkReceiveActionbulkReceiveAction

•InventoryShipmentReceiveLineItemReason

The bulk receive action for the inventory shipment.

Anchor to dateReceiveddateReceived

•DateTime

The date the inventory shipment was initially received.

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.

Was this section helpful?

Anchor to InventoryShipmentReceivePayload returnsInventoryShipmentReceivePayload returns

Anchor to inventoryShipmentinventoryShipment •InventoryShipment: The inventory shipment with received items.
Anchor to userErrorsuserErrors •[InventoryShipmentReceiveUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

inventoryShipmentReceive reference

Mutation Reference

mutation inventoryShipmentReceive($id: ID!, $lineItems: [InventoryShipmentReceiveItemInput!], $dateReceived: DateTime, $bulkReceiveAction: InventoryShipmentReceiveLineItemReason) {

inventoryShipmentReceive(id: $id, lineItems: $lineItems, dateReceived: $dateReceived, bulkReceiveAction: $bulkReceiveAction) {

inventoryShipment {

# InventoryShipment fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"lineItems": [

{

"shipmentLineItemId": "gid://shopify/<objectName>/10079785100",

"quantity": 1,

"reason": "ACCEPTED"

}

"dateReceived": "2019-09-07T15:50:00Z",

"bulkReceiveAction": "ACCEPTED"

}

Variables

{
  "id": "gid://shopify/<objectName>/10079785100",
  "lineItems": [
    {
      "shipmentLineItemId": "gid://shopify/<objectName>/10079785100",
      "quantity": 1,
      "reason": "ACCEPTED"
    }
  ],
  "dateReceived": "2019-09-07T15:50:00Z",
  "bulkReceiveAction": "ACCEPTED"
}

Schema

input InventoryShipmentReceiveItemInput {
  shipmentLineItemId: ID!
  quantity: Int!
  reason: InventoryShipmentReceiveLineItemReason!
}