inventoryShipmentRemoveItems

Remove items from an inventory shipment.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the inventoryShipmentRemoveItems action (under Inventory).
Fill in the fields below, then reference the result from later steps as {{inventoryshipmentremoveitems.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 InventoryShipmentRemoveItems($id: ID!, $lineItems: [ID!]!) {
  inventoryShipmentRemoveItems(id: $id, lineItems: $lineItems) {
    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 remove items from.

lineItemsarray<string>required

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

json

{
  "id": "string",
  "lineItems": [
    "string"
  ]
}

Response

Read the result with {{inventoryshipmentremoveitems.response.data.data.inventoryShipmentRemoveItems}}. If the API returns errors, the step fails and they are at {{inventoryshipmentremoveitems.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?