Return

The return object represents a return request for an order, including items, status, fees, and related information.

Usage Example

{%- comment -%} Show return summary and items {%- endcomment -%}
<h1>Return #{{ return.return_number }}</h1>
<p>Status: {{ return.return_status }}</p>
<p>Created at: {{ return.created_at | date: '%Y-%m-%d' }}</p>
<p>Note: {{ return.return_note }}</p>
<ul>
  {% for item in return.items %}
    <li>{{ item.title }} ({{ item.quantity }})</li>
  {% endfor %}
</ul>
<p>Total refund: {{ return.total_price | money }}</p>

Properties

billing_address

Returns the billing address for this return.

created_at

Returns the date when this return was created.

discounts

Returns discount lines applied to this return.

items

Returns the return line items.

num_items

Returns the number of line items in this return.

payment_fee

Returns the total payment fee for the return.

payment_methods

Returns the payment methods for this return.

return_note

Returns the note for this return.

return_number

Returns the return number.

return_status

Returns the status of the return.

shipping_methods

Returns the shipping methods for this return.

shipping_price

Returns the total shipping costs for the return.

subtotal_price

Returns the subtotal price for the return.

tax_lines

Returns the tax lines for the return.

total_net_price

Returns the net total for the return.

total_price

Returns the total refund amount for the return.

total_tax

Returns the total tax for the return.