Skip to main content
Anchor to inventoryShipmentCreateInTransit

inventoryShipmentCreateInTransit

mutation

Requires write_inventory_shipments access scope. Also: The user must have permission to manage inventory.

Adds an in-transit shipment to an inventory transfer.


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.


•InventoryShipmentCreateInput!
required

The input fields for the inventory shipment.


Was this section helpful?

Anchor to InventoryShipmentCreateInTransitPayload returnsInventoryShipmentCreateInTransitPayload returns

•InventoryShipment

The created inventory shipment.

•[InventoryShipmentCreateInTransitUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?