Skip to main content

markOrderAsReturned

Records that the whole shipment came back and moves the order's primary delivery to the returned state. This only records the return and does not put stock back into the warehouse. Shopware's default delivery state machine returns a shipped, shipped_partially or returned_partially delivery only; from any other state the mutation fails with CONFLICT. Fails with CONFLICT when the order has no delivery. Does nothing when the delivery is already returned. Fires the flows configured for the state change. Returns the order.

Required scopes​

The token needs the orders:write access scope.

markOrderAsReturned(
id: ID!
): Order!

Arguments​

markOrderAsReturned.id ● ID! non-null scalar​

ID of the order to mark as returned.

Type​

Order object​

A customer order.