Skip to main content
Anchor to InventoryShipmentReceivePayload

InventoryShipmentReceivePayload

payload

Return type for inventoryShipmentReceive mutation.

•InventoryShipment

The inventory shipment with received items.

•[InventoryShipmentReceiveUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

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.


Arguments

•ID!
required

The ID of the inventory shipment to receive.

•[InventoryShipmentReceiveItemInput!]

The list of receive line items for the inventory shipment.

•DateTime

The date the inventory shipment was initially received.

•InventoryShipmentReceiveLineItemReason

The bulk receive action for the inventory shipment.



Was this section helpful?