Refund part order but don't refund shipping

Question

at the moment I have a function which will refund the invoice on an order. However the shipping is currently also being refunded, which I don't want. Is there a way to set the shipping to zero on an invoice refund?

My code is currently this:

private function createCreditMemoItem($item)
{
    $creditmemoItem = $this->creditmemoItemFactory->create();
    $creditmemoItem->setOrderItemId($item->getId());
    $creditmemoItem->setQty($item->getQtyOrdered());

    return $creditmemoItem;
}

private function refundItems($order,$items) {
        $refundItems = $items;
        $items = [];

        foreach ($order->getAllVisibleItems() as $item) {
            if (!in_array($item->getId(), $refundItems)) {
                continue;
            }

            // create creditmemo item and add to array
            $creditmemoItem = $this->createCreditmemoItem($item);
            $items[] = $creditmemoItem;
        }
        
        // get the invoice id

        $invoiceId = null;

        foreach ($order->getInvoiceCollection() as $invoice) {
            // this will always point to the latest invoice id
            $invoiceId = $invoice->getId();
        }

        // refund the invoice
        $this->refundInvoice->execute(
            $invoiceId,
            $items,
            true, // false = offline / true = online
            true // notify customer
        );
    }

the refundInvoice uses the Magento\Sales\Api\RefundInvoiceInterface class.

So just to re-iterate, the partial refund works fine in the sense that, the individual items chosen are refunded but like I say, the shipping amount is also being refunded, which I don't want to happen :)

Any help would be appreciated.

Cheers

Answer 1

Ok, I figured this one out :D So basically when we run the `execute` method on the refundInvoice object, we need to send some arguments with it also.

We can set those arguments using the Magento\Sales\Model\Order\Creditmemo\CreationArgumentsFactory model.

If we assign the model to a $creationArguments property We can then set the shipping amount in the following way:

$arguments = $this->creationArguments->create();
$arguments->setShippingAmount(0); // don't refund the shipping when creating the credit memo

 // refund the invoice
$this->refundInvoice->execute(
    $invoiceId,
    $items,
    true, // false = offline / true = online
    true, // notify customer
    false, // append comment
    null, // CreditmemoCommentCreationInterface
    $arguments
);

I hope this helps someone else out who hit the same problem as I did :)