Skip to main content

markOrderAsPartiallyReturned

Records that part of the shipment came back and moves the order's primary delivery to the returned_partially state. This only records the return and does not put stock back into the warehouse. Shopware's default delivery state machine partially returns a shipped or shipped_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_partially. Fires the flows configured for the state change. Returns the order.

Required scopes​

The token needs the orders:write access scope.

markOrderAsPartiallyReturned(
id: ID!
): Order!

Arguments​

markOrderAsPartiallyReturned.id ● ID! non-null scalar​

ID of the order to mark as partially returned.

Type​

Order object​

A customer order.