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

return_number

Returns the return number.

created_at

Returns the date when this return was created at.

discounts

Return discount lines

subtotal_price

Returns the subtotal.

total_price

Returns the total.

total_net_price

Returns the net total.

total_tax

Returns the total tax.

tax_lines

Returns the tax lines.

return_status

Returns the return status

return_note

Returns the note for this return.

payment_fee

Returns the total payment fee.

shipping_price

Returns the total shipping costs.

items

Returns the return line items.

billing_address

Returns the billing address for this order.

num_items

Returns the amount of line items in this return.

payment_methods

Returns the payment methods for this order.

shipping_methods

Returns the shipping methods for this order.