inventoryShipmentReceive

Receive an inventory shipment. Caution: As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the inventoryShipmentReceive action (under Inventory).
Fill in the fields below, then reference the result from later steps as {{inventoryshipmentreceive.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation InventoryShipmentReceive($id: ID!, $lineItems: [InventoryShipmentReceiveItemInput!], $dateReceived: DateTime, $bulkReceiveAction: InventoryShipmentReceiveLineItemReason) {
  inventoryShipmentReceive(
    id: $id
    lineItems: $lineItems
    dateReceived: $dateReceived
    bulkReceiveAction: $bulkReceiveAction
  ) {
    inventoryShipment {
      barcode
      dateCreated
      dateReceived
      dateShipped
      id
      lineItemTotalQuantity
      name
      status
      totalAcceptedQuantity
      totalReceivedQuantity
      totalRejectedQuantity
      tracking {
        arrivesAt
        company
        trackingNumber
        trackingUrl
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the inventory shipment to receive.

lineItemsarray<object>

The list of receive line items for the inventory shipment.

shipmentLineItemIdstringrequired

quantitynumberrequired

reasonstringrequired

One ofACCEPTEDREJECTED

dateReceivedstring

The date the inventory shipment was initially received.

bulkReceiveActionstring

The bulk receive action for the inventory shipment.

One ofACCEPTEDREJECTED

json

{
  "id": "string",
  "lineItems": [
    {
      "shipmentLineItemId": "string",
      "quantity": 0,
      "reason": "ACCEPTED"
    }
  ],
  "dateReceived": "string",
  "bulkReceiveAction": "ACCEPTED"
}

Response

Read the result with {{inventoryshipmentreceive.response.data.data.inventoryShipmentReceive}}. If the API returns errors, the step fails and they are at {{inventoryshipmentreceive.response.data.errors}}.

inventoryShipmentobject

barcodestring

dateCreatedstring

dateReceivedstring

dateShippedstring

idstring

lineItemTotalQuantitynumber

namestring

statusstring

One ofDRAFTIN_TRANSITPARTIALLY_RECEIVEDRECEIVEDOTHER

totalAcceptedQuantitynumber

totalReceivedQuantitynumber

totalRejectedQuantitynumber

trackingobject4 fields

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?