inventoryShipmentReceive

mutation

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

Receive an inventory shipment.

Arguments

Anchor to bulkReceiveActionbulkReceiveAction • InventoryShipmentReceiveLineItemReason: The bulk receive action for the inventory shipment.
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?

Mutation Reference

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

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

inventoryShipment {

# InventoryShipment fields

}

userErrors {

field

message

}

Input

{

"bulkReceiveAction": "ACCEPTED",

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

"lineItems": [

{

"quantity": 1,

"reason": "ACCEPTED",

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

}

]

}

{
  "bulkReceiveAction": "ACCEPTED",
  "id": "gid://shopify/<objectName>/10079785100",
  "lineItems": [
    {
      "quantity": 1,
      "reason": "ACCEPTED",
      "shipmentLineItemId": "gid://shopify/<objectName>/10079785100"
    }
  ]
}

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