Help Center
English
Contents

Order Cancelled and Partially Refunded

Tells the customer their order was cancelled and part of the payment refunded.

When it's sent

Sent when an order is cancelled and part of the payment has been refunded, or when a later refund on a cancelled order still leaves part unrefunded. Refunds still pending at the payment provider don't count. Not sent for imported orders.

At a glance
  • Category: Transactional. About something the customer did or asked for, such as an order, a refund, a gift card or a request.

  • Channels: Email, SMS, WhatsApp

  • Can be switched off: Yes

What it also needs

It goes only on channels that are switched on. Email needs the customer's email address. A text needs the customer's phone number, the message turned on in Transactional messages and a ready SMS or WhatsApp provider. Off by default.

Related settings
  • Customer notifications

  • Transactional messages

  • Message templates

  • Transactional emails

  • Service providers

Values it can read

Its template can print these values. Write a value's path between double braces, such as {{ shop.name }}. [] marks one entry of a list, read inside a loop: order.items[].title is item.title in {% for item in order.items %}. A value the event has no data for prints nothing.

SMS and WhatsApp texts read the same values, except the email values.

Customer#

Value

Path

First name

customer.first_name

Last name

customer.last_name

Email address

customer.email

Has an account

customer.has_account

Order#

Value

Path

Customer tax ID

order.customer_tax_id

Customer tax ID type

order.customer_tax_id_type

Tax exemption reason

order.tax_exemption_source

Order ID

order.id

Order number

order.number

Order date

order.created_at

Order status page

order.status_url

Order status page path

order.status_path

Save information link

order.save_information_url

Payment

order.payment

Payment › Payment method key

order.payment.method

Payment › Payment method

order.payment.method_label

Payment › Cash on delivery

order.payment.is_cod

Payment › Payment status

order.payment.status

Totals

order.totals

Totals › Has a discount

order.totals.has_discount

Totals › Has a shipping line

order.totals.has_shipping

Totals › Free shipping

order.totals.shipping_free

Totals › Has a cash on delivery fee

order.totals.has_cod_fee

Totals › Has checkout fees

order.totals.has_checkout_fees

Totals › Has duties

order.totals.has_duties

Totals › Has tax

order.totals.has_tax

Totals › Has a refund

order.totals.has_refunded

Totals › Has store credit

order.totals.has_store_credit

Totals › Has a gift card payment

order.totals.has_gift_card

Totals › Has a payment

order.totals.has_paid

Totals › Has an amount due

order.totals.has_due

Totals › Subtotal

order.totals.subtotal

Totals › Total discount

order.totals.discount

Totals › Shipping

order.totals.shipping

Totals › Shipping taxes

order.totals.shipping_tax_lines

Totals › Shipping taxes › Included in the price

order.totals.shipping_tax_lines[].included

Totals › Shipping taxes › Tax name

order.totals.shipping_tax_lines[].name

Totals › Shipping taxes › Tax rate

order.totals.shipping_tax_lines[].rate

Totals › Shipping taxes › Tax amount

order.totals.shipping_tax_lines[].amount

Totals › Tax

order.totals.tax

Totals › Cash on delivery fee

order.totals.cod_fee

Totals › Cash on delivery fee taxes

order.totals.cod_fee_tax_lines

Totals › Cash on delivery fee taxes › Included in the price

order.totals.cod_fee_tax_lines[].included

Totals › Cash on delivery fee taxes › Tax name

order.totals.cod_fee_tax_lines[].name

Totals › Cash on delivery fee taxes › Tax rate

order.totals.cod_fee_tax_lines[].rate

Totals › Cash on delivery fee taxes › Tax amount

order.totals.cod_fee_tax_lines[].amount

Totals › Checkout Fees

order.totals.checkout_fees

Totals › Checkout fees, one by one

order.totals.checkout_fee_lines

Totals › Checkout fees, one by one › Fee name

order.totals.checkout_fee_lines[].name

Totals › Checkout fees, one by one › Fee amount

order.totals.checkout_fee_lines[].amount

Totals › Checkout fees, one by one › How the fee was calculated

order.totals.checkout_fee_lines[].calculation

Totals › Checkout fees, one by one › How the fee was calculated › Calculation kind (per_item or percent)

order.totals.checkout_fee_lines[].calculation.kind

Totals › Checkout fees, one by one › How the fee was calculated › Fee per item

order.totals.checkout_fee_lines[].calculation.unit_amount

Totals › Checkout fees, one by one › How the fee was calculated › Number of items

order.totals.checkout_fee_lines[].calculation.quantity

Totals › Checkout fees, one by one › How the fee was calculated › Percentage

order.totals.checkout_fee_lines[].calculation.rate

Totals › Checkout fees, one by one › How the fee was calculated › Amount the percentage was taken of

order.totals.checkout_fee_lines[].calculation.base

Totals › Checkout fees, one by one › How the fee was calculated › Calculation line

order.totals.checkout_fee_lines[].calculation.text

Totals › Checkout fees, one by one › Customer's text

order.totals.checkout_fee_lines[].customer_text

Totals › Checkout fees, one by one › Text prompt

order.totals.checkout_fee_lines[].text_prompt

Totals › Checkout fees, one by one › Fee taxes

order.totals.checkout_fee_lines[].tax_lines

Totals › Checkout fees, one by one › Fee taxes › Included in the price

order.totals.checkout_fee_lines[].tax_lines[].included

Totals › Checkout fees, one by one › Fee taxes › Tax name

order.totals.checkout_fee_lines[].tax_lines[].name

Totals › Checkout fees, one by one › Fee taxes › Tax rate

order.totals.checkout_fee_lines[].tax_lines[].rate

Totals › Checkout fees, one by one › Fee taxes › Tax amount

order.totals.checkout_fee_lines[].tax_lines[].amount

Totals › Duties

order.totals.duties

Totals › Grand total

order.totals.total

Totals › Refunded

order.totals.refunded

Totals › Store credit

order.totals.store_credit

Totals › Gift Card

order.totals.gift_card

Totals › Amount paid

order.totals.paid

Totals › Amount due

order.totals.due

Totals › Due on delivery

order.totals.due_on_delivery

Totals › Due at pickup

order.totals.due_at_pickup

Totals › Tax included

order.totals.tax_included

Totals › Taxes by rate

order.totals.tax_lines

Totals › Taxes by rate › Included in the price

order.totals.tax_lines[].included

Totals › Taxes by rate › Tax name

order.totals.tax_lines[].name

Totals › Taxes by rate › Tax rate

order.totals.tax_lines[].rate

Totals › Taxes by rate › Tax amount

order.totals.tax_lines[].amount

Totals › Number of tax lines

order.totals.tax_line_count

Totals › Tax list shortened

order.totals.tax_lines_truncated

Totals › Other taxes

order.totals.other_tax

Import duties

order.duties

Import duties › Who pays import duties

order.duties.mode

Import duties › Estimated duties and taxes due on delivery

order.duties.estimate

Import duties › Import duties note

order.duties.note

Items

order.items

Items › Line ID

order.items[].id

Items › Product name

order.items[].title

Items › Variant name

order.items[].variant_title

Items › SKU

order.items[].sku

Items › Product image

order.items[].image_url

Items › Product link

order.items[].product_url

Items › Quantity

order.items[].quantity

Items › Unit price

order.items[].unit_price

Items › Compare-at price

order.items[].compare_at_price

Items › Line discount

order.items[].discount

Items › Line total

order.items[].line_total

Items › Line taxes

order.items[].tax_lines

Items › Line taxes › Included in the price

order.items[].tax_lines[].included

Items › Line taxes › Tax name

order.items[].tax_lines[].name

Items › Line taxes › Tax rate

order.items[].tax_lines[].rate

Items › Line taxes › Tax amount

order.items[].tax_lines[].amount

Items › Line properties

order.items[].properties

Items › Line properties › Property name

order.items[].properties[].name

Items › Line properties › Property value

order.items[].properties[].value

Items › Line details

order.items[].details

Items › Line details › Detail name

order.items[].details[].name

Items › Line details › Detail text

order.items[].details[].value

Items › Line details › Detail link

order.items[].details[].url

Number of items

order.item_count

Number of lines

order.line_count

Item list shortened

order.items_truncated

Discounts

order.discounts

Discounts › Discount code

order.discounts[].code

Discounts › Discount name

order.discounts[].title

Discounts › Discount type

order.discounts[].type

Discounts › Discount amount

order.discounts[].amount

Shipping address

order.shipping_address

Shipping address › First name

order.shipping_address.first_name

Shipping address › Last name

order.shipping_address.last_name

Shipping address › Company name

order.shipping_address.company

Shipping address › Address line 1

order.shipping_address.address1

Shipping address › Address line 2

order.shipping_address.address2

Shipping address › District

order.shipping_address.district

Shipping address › City

order.shipping_address.city

Shipping address › State or region code

order.shipping_address.province_code

Shipping address › State or region

order.shipping_address.province_name

Shipping address › Postal code

order.shipping_address.postal_code

Shipping address › Country code

order.shipping_address.country_code

Shipping address › Country

order.shipping_address.country_name

Shipping address › Phone number

order.shipping_address.phone

Shipping address › Full address

order.shipping_address.formatted

Billing address

order.billing_address

Billing address › First name

order.billing_address.first_name

Billing address › Last name

order.billing_address.last_name

Billing address › Company name

order.billing_address.company

Billing address › Address line 1

order.billing_address.address1

Billing address › Address line 2

order.billing_address.address2

Billing address › District

order.billing_address.district

Billing address › City

order.billing_address.city

Billing address › State or region code

order.billing_address.province_code

Billing address › State or region

order.billing_address.province_name

Billing address › Postal code

order.billing_address.postal_code

Billing address › Country code

order.billing_address.country_code

Billing address › Country

order.billing_address.country_name

Billing address › Phone number

order.billing_address.phone

Billing address › Full address

order.billing_address.formatted

Shipping method

order.shipping_method

Pickup location

order.pickup

Pickup location › Location name

order.pickup.name

Pickup location › Location address

order.pickup.address

Pickup location › Location phone

order.pickup.phone

Pickup location › Usually ready in

order.pickup.ready_in

Pickup location › Pickup instructions

order.pickup.instructions

Pickup location › Opening hours

order.pickup.hours

Needs shipping

order.requires_shipping

Customer note

order.customer_note

Checkout answers

order.checkout_answers

Checkout answers › Question

order.checkout_answers[].label

Checkout answers › Answer

order.checkout_answers[].value

Cancellation reason

order.cancel_reason

Refund#

Value

Path

Refunded goods amount

refund.goods

Refund amount

refund.amount

Total refunded

refund.total_refunded

Tax refunded

refund.tax

Taxes by rate

refund.tax_lines

Taxes by rate › Included in the price

refund.tax_lines[].included

Taxes by rate › Tax name

refund.tax_lines[].name

Taxes by rate › Tax rate

refund.tax_lines[].rate

Taxes by rate › Tax amount

refund.tax_lines[].amount

Number of tax lines

refund.tax_line_count

Tax list shortened

refund.tax_lines_truncated

Other taxes refunded

refund.other_tax

Refund reason

refund.reason

Partial refund

refund.is_partial

Refunded items

refund.items

Refunded items › Line ID

refund.items[].id

Refunded items › Product name

refund.items[].title

Refunded items › Variant name

refund.items[].variant_title

Refunded items › SKU

refund.items[].sku

Refunded items › Product image

refund.items[].image_url

Refunded items › Product link

refund.items[].product_url

Refunded items › Quantity

refund.items[].quantity

Refunded items › Unit price

refund.items[].unit_price

Refunded items › Compare-at price

refund.items[].compare_at_price

Refunded items › Line discount

refund.items[].discount

Refunded items › Line total

refund.items[].line_total

Refunded items › Line taxes

refund.items[].tax_lines

Refunded items › Line taxes › Included in the price

refund.items[].tax_lines[].included

Refunded items › Line taxes › Tax name

refund.items[].tax_lines[].name

Refunded items › Line taxes › Tax rate

refund.items[].tax_lines[].rate

Refunded items › Line taxes › Tax amount

refund.items[].tax_lines[].amount

Refunded items › Line properties

refund.items[].properties

Refunded items › Line properties › Property name

refund.items[].properties[].name

Refunded items › Line properties › Property value

refund.items[].properties[].value

Refunded items › Line details

refund.items[].details

Refunded items › Line details › Detail name

refund.items[].details[].name

Refunded items › Line details › Detail text

refund.items[].details[].value

Refunded items › Line details › Detail link

refund.items[].details[].url

Item list shortened

refund.items_truncated

Refund destinations

refund.destinations

Refund destinations › Refund method

refund.destinations[].method

Refund destinations › Goes back to

refund.destinations[].label

Refund destinations › Amount

refund.destinations[].amount

Store#

Value

Path

Store name

shop.name

Store link

shop.url

Store logo

shop.logo_url

Support email

shop.support_email

Store address

shop.address

Store address › First name

shop.address.first_name

Store address › Last name

shop.address.last_name

Store address › Company name

shop.address.company

Store address › Address line 1

shop.address.address1

Store address › Address line 2

shop.address.address2

Store address › District

shop.address.district

Store address › City

shop.address.city

Store address › State or region code

shop.address.province_code

Store address › State or region

shop.address.province_name

Store address › Postal code

shop.address.postal_code

Store address › Country code

shop.address.country_code

Store address › Country

shop.address.country_name

Store address › Phone number

shop.address.phone

Store address › Full address

shop.address.formatted

Social links

shop.social

Social links › Network

shop.social[].network

Social links › Profile link

shop.social[].url

This email (emails only)#

Value

Path

Preview text

email.preview_text

Email parts it can use

Its email code can add these parts of the email library with {% render %}. An email offers only the parts it has data for.

  • {% render 'button' %}: A button in your accent colour that works in every email program.

  • {% render 'eyebrow' %}: A small line in capitals above a heading, such as the order number and date.

  • {% render 'footer' %}: The store's name and its support address.

  • {% render 'header' %}: The store's logo (from Email design), or its name when there is no logo, linking to the store.

  • {% render 'items' %}: The email's items with their photo, variant, quantity and price, then the totals: subtotal, discount, shipping, fees, duties, tax and total. Only the lines the order has are shown. In a refund email these are the refunded items; in a cart or checkout reminder, the cart's items without prices.

  • {% render 'order_details' %}: The order's shipping and billing address, shipping method or pickup location, payment and the customer's note, each under its heading, in two columns (one on phones). A part the order has no value for is left out.

  • {% render 'progress' %}: The order's progress bar: Ordered, Shipped, Out for delivery, Delivered, or the pickup steps for a pickup order. Orders with nothing to ship or pick up show no bar.

  • {% render 'tax_details' %}: The tax breakdown: each tax with its rate and amount, and whether prices included it, where the email places it. Emails without tax lines show nothing.

Was this page helpful?