Route Returns × Klaviyo: Template Variable Reference

1

Return Confirmation

Customer submits a return request

2

Return Canceled

A return is canceled, either by the customer or merchant

3

Return Delivered Confirmation

Carrier marks the return shipment as delivered to the warehouse

4

Refund Confirmation

A refund has been successfully processed for the return

5

Exchange Processed

An exchange order has been placed and is being fulfilled

6

Ship Back Request

Customer is sent their return label / ship-back instructions (including resends)

7

Ship Back Warning

Return label is nearing its expiry deadline and the item has not yet been shipped

8

Ship Back Confirmation

Carrier has scanned the return shipment — package is in transit back to the warehouse

9

Image Verification Reupload

Merchant has requested the customer resubmit product images for verification

order_name

{{ event.order_name }}

e.g. #1234

hold_period_end

{{ event.hold_period_end }}

is_self_ship

{{ event.is_self_ship }}

Boolean — True if customer uses their own label

$value

{{ event.$value }}

Refund quote amount (number)

$value_currency

{{ event.$value_currency }}

e.g. USD

items[].title

{{ item.title }}

Product name

items[].description

{{ item.description }}

Variant name

items[].price_amount

{{ item.price_amount }}

Presentment price (number)

items[].price_currency_code

{{ item.price_currency_code }}

e.g. USD

items[].image_url

{{ item.image_url }}

Product image URL

cancellation_reason

{{ event.cancellation_reason }}

notify_customer

{{ event.notify_customer }}

Boolean

$value

{{ event.$value }}

$value_currency

{{ event.$value_currency }}

items[].title

{{ item.title }}

items[].description

{{ item.description }}

items[].price_amount

{{ item.price_amount }}

items[].price_currency_code

{{ item.price_currency_code }}

items[].image_url

{{ item.image_url }}

$value

{{ event.$value }}

Always 0.0 for this event

$value_currency

{{ event.$value_currency }}

items[].title

{{ item.title }}

items[].description

{{ item.description }}

items[].price_amount

{{ item.price_amount }}

items[].price_currency_code

{{ item.price_currency_code }}

items[].image_url

{{ item.image_url }}

total_refund_amount

{{ event.total_refund_amount }}

Total refunded (number, presentment currency)

total_refund_currency_code

{{ event.total_refund_currency_code }}

e.g. USD

gift_card_codes

{{ event.gift_card_codes }}

Array of strings — empty if no gift cards issued

refund_breakdown

{{ event.refund_breakdown }}

Breakdown lines per refund group

$value

{{ event.$value }}

$value_currency

{{ event.$value_currency }}

items[].title

{{ item.title }}

items[].description

{{ item.description }}

items[].price_amount

{{ item.price_amount }}

items[].price_currency_code

{{ item.price_currency_code }}

items[].image_url

{{ item.image_url }}

transactions[].description

{{ tx.description }}

Gateway name + masked account number

transactions[].price_amount

{{ tx.price_amount }}

Amount for that transaction

transactions[].price_currency_code

{{ tx.price_currency_code }}

$value

{{ event.$value }}

$value_currency

{{ event.$value_currency }}

exchange_line_items[].title

{{ item.title }}

Product name

exchange_line_items[].description

{{ item.description }}

Variant name

exchange_line_items[].price_amount

{{ item.price_amount }}

Discounted presentment price

exchange_line_items[].price_currency_code

{{ item.price_currency_code }}

exchange_line_items[].image_url

{{ item.image_url }}

Nullable

exchange_line_items[].metafields

{{ item.metafields }}

Product metafields array

ship_back_resend_note

{{ event.ship_back_resend_note }}

Null on first send, populated on resends

ship_back_deadline

{{ event.ship_back_deadline|format_date_string|date:'F d, o' }}

ISO 8601 → nullable — wrap in {% if %}

$value

{{ event.$value }}

$value_currency

{{ event.$value_currency }}

shipments[].title

{{ shipment.title }}

Shipment name / method label

shipments[].label_url

{{ shipment.label_url }}

Printable return label URL

shipments[].tracking_code

{{ shipment.tracking_code }}

shipments[].instructions_title

{{ shipment.instructions_title }}

Plain text, HTML already stripped

shipments[].instructions_description

{{ shipment.instructions_description }}

Plain text, HTML already stripped

shipments[].instructions_locations

{{ shipment.instructions_locations }}

Drop-off location details array

shipments[].items[].title

{{ item.title }}

Via nested loop

shipments[].items[].image_url

{{ item.image_url }}

Via nested loop

exchange_line_items[].title

{{ item.title }}

exchange_line_items[].description

{{ item.description }}

exchange_line_items[].price_amount

{{ item.price_amount }}

exchange_line_items[].price_currency_code

{{ item.price_currency_code }}

exchange_line_items[].image_url

{{ item.image_url }}

exchange_line_items[].metafields

{{ item.metafields }}

kept_line_items[].title

{{ item.title }}

kept_line_items[].description

{{ item.description }}

kept_line_items[].price_amount

{{ item.price_amount }}

kept_line_items[].price_currency_code

{{ item.price_currency_code }}

kept_line_items[].image_url

{{ item.image_url }}

kept_line_items[].keep_item

{{ item.keep_item }}

Boolean — always True in this array

ship_back_deadline

{{ event.ship_back_deadline|format_date_string|date:'F d, o' }}

ISO 8601 → nullable

ship_back_deadline_expired

{{ event.ship_back_deadline_expired }}

Boolean — use to differentiate warning vs expired

$value

{{ event.$value }}

$value_currency

{{ event.$value_currency }}

shipments[].title

{{ shipment.title }}

shipments[].label_url

{{ shipment.label_url }}

shipments[].tracking_code

{{ shipment.tracking_code }}

shipments[].instructions_title

{{ shipment.instructions_title }}

shipments[].instructions_description

{{ shipment.instructions_description }}

shipments[].items[].title

{{ item.title }} (nested loop)

exchange_line_items[].title

{{ item.title }}

exchange_line_items[].image_url

{{ item.image_url }}

exchange_line_items[].price_amount

{{ item.price_amount }}

exchange_line_items[].price_currency_code

{{ item.price_currency_code }}

$value

{{ event.$value }}

$value_currency

{{ event.$value_currency }}

shipments[].title

{{ shipment.title }}

shipments[].tracking_code

{{ shipment.tracking_code }}

shipments[].label_url

{{ shipment.label_url }}

shipments[].instructions_title

{{ shipment.instructions_title }}

shipments[].instructions_description

{{ shipment.instructions_description }}

shipments[].items[].title

{{ item.title }} (nested loop)

shipments[].items[].image_url

{{ item.image_url }} (nested loop)

reupload_url

{{ event.reupload_url }}

JWT-authenticated deep link — expires

reupload_note

{{ event.reupload_note }}

Nullable — merchant's note to the customer

$value

{{ event.$value }}

$value_currency

{{ event.$value_currency }}

items[].title

{{ item.title }}

items[].description

{{ item.description }}

items[].price_amount

{{ item.price_amount }}

items[].price_currency_code

{{ item.price_currency_code }}

items[].image_url

{{ item.image_url }}