variables.md

gistfile1.txt

| Variable | Example | Notes |
| --- | --- | --- |
| `date` | Feb 21, 2016 | The current date |
| `time` | 14:17 | The current time |
| `order.code` | 01234567890123456 |
| `order.reference` | XXX-YYY-ZZZ |
| `order.external_reference` | BK-1112302 |
| `order.voucher_code` | XYWJ02222X |
| `customer.full_name` | John Smith |
| `customer.first_name` | John |
| `customer.last_name` | Smith |
| `customer.email` | [email protected] |
| `customer.mobile` | +447840739437 |
| `customer.address` | Room 107, Marylane Hotel, San Fansisco |
| `reseller.name` | Hotel A |
| `outlet.name` | Storefront A |
| `agent.name` | Oliver Morgan |
| `seller.name` | Javier Gomez-Acebo |
| `terminal.name` | Terminal A |
| `location.name` | Town Square |
| `shift.date` | Feb 21, 2016 |
| `shift.started_at` | 10:30 |
| `order.test` | `TEST ORDER` if true, blank if false |
| `order.total` | USD 10.00 |
| `order.payment_method` | Cash | Cash, Card, Voucher or Other |
| `order.currency` | EUR |
| `order.created_at` | 21 Feb 14:17 |
| `booking.code` | 1234567890123456 |
| `booking.reference` | XXX-YYY-ZZZ |
| `booking.status` | Confirmed | Completed, Confirmed, Balance Due or Cancelled |
| `product.name` | Hop-on Hop-off |
| `product.description` | Explore the city on this unlimited use bus tour |
| `product.redemption_instructions` | Please visit our visitor centre just off the main square to redeem this ticket. |
| `product.usage_instructions` | Simply present your ticket at the bus tour and hop on! |
| `option.name` | 1-Day Pass |
| `option.description` | Unlimited use for 24 hours after purchase |
| `tour.time` | 10:30 |
| `tour.language` | EN |
| `pickup.name` | Marylane Hotel |
| `pickup.address` | Marylane Hotel, San Fransisco |
| `booking.pickup_room` | 101 |
| `booking.pickup_time` | 11:45 |
| `promotion.name` | Local Resident |
| `promotion.discount` | 10% OFF |
| `booking.size` | 5 |
| `booking.freesale` | `Freesale` if true, blank if false |
| `booking.date` | 21 Jun, 2016 | Tavel date|
| `booking.valid_from` | 21 Jun, 2016 | If freesale, when is the booking valid from |
| `booking.expires_on` | 28 Jun, 2016 | If freesale, when does the booking expire |
| `booking.discount` | USD 5.00 | The total discount given on the booking  |
| `booking.total` | USD 15.00 | The booking total (after discount) |
| `booking.payable` | USD 5.00 | How much is due to be paid up-front |
| `booking.balance` | USD 10.00 | How much is due to be collected |
| `booking.deposit` | USD 5.00 | How much deposit was paid |
| `booking.redeemed_at` | 14:31 Jun 18 |
| `pass.code` | 1234567890123456 |
| `pass.reference` | XXX-YYY-ZZZ |
| `pass.status` | Confirmed | Completed, Confirmed, Balance Due or Cancelled |
| `pass.valid_from` | 12 Jun, 2016 |
| `pass.expires_on` | 18 Jun, 2016 |
| `package.name` | Bus/Boat Combo |
| `package.name` | Bus/Boat Combo |
| `package.description` | Visit the city by both bus and boat together! |
| `promotion.name` | Local Resident |
| `promotion.discount` | 10% OFF |
| `pass.discount` | USD 5.00 | The total discount given on the booking  |
| `pass.total` | USD 15.00 | The booking total (after discount) |
| `pass.payable` | USD 5.00 | How much is due to be paid up-front |
| `pass.balance` | USD 10.00 | How much is due to be collected |
| `pass.deposit` | USD 5.00 | How much deposit was paid |
| `booking.redeemed_at` | 14:31 Jun 18 |
| `ticket.code` | 1234567890123456 |
| `ticket.reference` | XXX-YYY-ZZZ |
| `ticket.tier` | Adult |
| `ticket.discount` | EUR 5.00 |
| `ticket.price` | EUR 10.00 |