Inventory Shipment Receive Payload
Return type for mutation.
Anchor to FieldsFields
- inventoryShipment (InventoryShipment)
- userErrors ([InventoryShipmentReceiveUserError!]!)
- Anchor to inventoryShipmentinventory•Inventory
Shipment Shipment The inventory shipment with received items.
- Anchor to userErrorsuser•[Inventory
Errors Shipment Receive User Error!]! non-null The list of errors that occurred from executing the mutation.
Anchor to Mutations with this payloadMutations with this payload
- inventoryShipmentReceive (InventoryShipmentReceivePayload)
- •mutation
Receive an inventory shipment.
CautionAs of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution:As of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution: As of 2026-01, this mutation supports an optional idempotency key using the <code>@idempotent</code> directive. As of 2026-04, the idempotency key is required and must be provided using the <code>@idempotent</code> directive. For more information, see the <a href="https://shopify.dev/docs/api/usage/idempotent-requests">idempotency documentation</a>.
- •ID!required
The ID of the inventory shipment to receive.
- Anchor to lineItemsline•[Inventory
Items Shipment Receive Item Input!] The list of receive line items for the inventory shipment.
- Anchor to dateReceiveddate•Date
Received Time The date the inventory shipment was initially received.
- Anchor to bulkReceiveActionbulk•Inventory
Receive Action Shipment Receive Line Item Reason The bulk receive action for the inventory shipment.
Arguments
- •ID!