Checkout
Below are documented:
- the variables for the
checkout-addresses.htmlpage to enter billing and shipping addresses - the variables for the
checkout-methods.htmlpage to choose payment and shipping methods - the variables for the
checkout-review.htmlsummary page before confirming the order - the variables for the
checkout-confirmation.htmlorder confirmation page - the variables for the
checkout-quote-request.htmlpage to fill in and send a quote request - the variables for the
checkout-form.htmlpage
In addition to these you can also use the variables common to all pages.
checkout-addresses.html
First checkout page where billing and shipping addresses are entered.
| Instruction | Variable | Description |
|---|---|---|
| show | acceptTerms | Checkbox to accept the sales terms and privacy policy |
| show | city | City |
| show | companyCode | VAT number |
| show | companyCode2 | REA |
| show | companyName | Company name |
| show | content | Page content |
| show | continue | Button to continue with the order |
| show | country | Country |
| show | Email address | |
| show | faxNumber | Fax number |
| show | firstName | First name |
| show | goBack | Button to return to the cart |
| show | image | Page image |
| show | invoiceRecipient | Recipient code or PEC address for electronic invoice new |
| show | lastName | Last name |
| show | mobileNumber | Mobile number |
| show | personalCode | Tax code |
| show | phoneNumber | Phone number |
| show | postalCode | Postal code |
| for | processings | Processings |
| show | shipCity | Shipping city |
| show | shipCountry | Shipping country |
| show | shipName | Shipping recipient name |
| show | shipPostalCode | Shipping postal code |
| show | shipStateProv | Shipping province |
| show | shipStreet1 | Shipping street |
| show | shipStreet2 | Shipping street, second line |
| show | shipToAnotherAddress | Checkbox to ship to an address different from the billing address |
| show | stateProv | Province |
| show | statusMessage | Message informing about any errors in form completion |
| show | street1 | Street |
| show | street2 | Street, second line |
| show | title | Page title |
checkout-methods.html
Second checkout page where the customer chooses payment and shipping methods.
| Instruction | Variable | Description |
|---|---|---|
| show | content | Page content |
| show | continue | Button to continue with the order |
| show | image | Page image |
| show | requests | Customer requests |
| for | payments | Payment methods |
| show | goBack | Button to return to addresses |
| for | shippings | Shipping methods |
| show | statusMessage | Message informing about any errors in form completion |
| show | title | Page title |
for payments
| Instruction | Variable | Description |
|---|---|---|
| show | choice | Selectable box to choose the payment method |
| show | description | Description |
| show | name | Name |
for shippings
| Instruction | Variable | Description |
|---|---|---|
| show | choice | Selectable box to choose the shipping method |
| show | name | Name |
checkout-review.html
Order summary where it is possible to verify the correctness of all previously entered data before confirming the order.
| Instruction | Variable | Description |
|---|---|---|
| show | billingAddress | Billing address |
| show | companyCode | VAT number |
| show | content | Page content |
| show | discount | Percentage or fixed discount on the order |
| for | discounts | Discounts applied to the total cart cost |
| show | Email address | |
| show | faxNumber | Fax number |
| show | goBack | Button to return to payment and shipping methods |
| show | image | Page image |
| for | items | Product SKUs being ordered. It is the same as the cart.html page |
| show | mobileNumber | Mobile number |
| show | order | Button to confirm and place the order |
| show | payment | Payment method |
| show | paymentCost | Payment cost, for example due to a fee or cash on delivery |
| show | paymentCostTax | Payment cost, VAT included, for example due to a fee or cash on delivery |
| show | personalCode | Tax code |
| show | phoneNumber | Phone number |
| show | prediscountSubtotal | Total cost before applying any discount |
| show | prediscountSubtotalTax | Total cost, VAT included, before applying any discount |
| show | requests | Customer requests |
| show | shipping | Shipping method |
| show | shippingAddress | Shipping address |
| show | shippingCost | Shipping cost |
| show | shippingCostTax | Shipping cost VAT included |
| show | taxes | Total taxes amount |
| show | title | Page title |
| show | total | Total |
| show | totalTax | Total VAT included |
| show | totalCost | Total cost |
| show | totalCostTax | Total cost VAT included |
| show | weight | Total weight |
for discounts
| Instruction | Variable | Description |
|---|---|---|
| show | discount | Fixed or percentage discount |
| show | discountTax | Fixed discount VAT included |
checkout-confirmation.html
Final checkout page where confirmation of the completed order is given. If online payment is required, the button to proceed will be shown.
After payment, you will return to this page where the transaction outcome will be communicated. With some payment methods, you can try the payment again in case of a negative outcome.
| Instruction | Variable | Description |
|---|---|---|
| show | content | Text on the home page |
| show | image | Page image |
| show | number | Order number |
| show | pay | Button to pay online |
| show | payment | Payment method |
| if | paymentApproved | Indicates whether the payment was executed and approved |
| show | paymentInstructions | Payment instructions |
| if | paymentError | Indicates whether a payment error occurred |
| if | paymentFailed | Indicates whether the payment was executed but failed |
| if | paymentUnknown | Indicates whether the payment status is unknown |
| show | title | Page title |
| show | total | Order total |
| show | totalTax | Order total VAT included |
checkout-quote-request.html
Filling in and sending the quote request. This page is reached when the cart is a quote and the customer proceeds with the quote request.
| Instruction | Variable | Description |
|---|---|---|
| show | acceptTerms | Checkbox to accept the sales terms and privacy policy |
| show | city | City |
| show | companyCode | VAT number |
| show | companyCode2 | REA |
| show | companyName | Company name |
| show | content | Page content |
| show | country | Country |
| show | Email address | |
| show | faxNumber | Fax number |
| show | firstName | First name |
| show | goBack | Button to return to the cart |
| show | image | Page image |
| show | invoiceRecipient | Recipient code or PEC address for electronic invoice new |
| for | items | SKUs for which the quote is requested. It is the same as the cart.html page |
| show | lastName | Last name |
| show | mobileNumber | Mobile number |
| show | personalCode | Tax code |
| show | postalCode | Postal code |
| show | phoneNumber | Phone number |
| for | processings | Processings |
| show | requests | Customer requests |
| show | sendQuoteRequest | Button to send the quote request |
| show | shipCity | Shipping city |
| show | shipCountry | Shipping country |
| show | shipName | Shipping recipient name |
| show | shipPostalCode | Shipping postal code |
| show | shipStateProv | Shipping province |
| show | shipStreet1 | Shipping street |
| show | shipStreet2 | Shipping street, second line |
| show | shipToAnotherAddress | Checkbox to ship to an address different from the billing address |
| show | stateProv | Province |
| show | statusMessage | Message informing about any errors in form completion |
| show | street1 | Street |
| show | street2 | Street, second line |
| show | title | Page title |
| if | toQuote | Indicates whether the cart is a quote |
checkout-quote-confirmation.html
Confirms that the quote request has been sent.
The page only has the variables of the generic pages.
checkout-form.html
| Instruction | Variable | Description |
|---|---|---|
| show | acceptTerms | Checkbox to accept the sales terms and privacy policy |
| show | city | City |
| show | companyCode | VAT number |
| show | companyCode2 | REA |
| show | companyName | Company name |
| show | content | Page content |
| show | continue | Button to continue with the order |
| show | country | Country |
| show | discount | Percentage or fixed discount on the order |
| show | Email address | |
| show | faxNumber | Fax number |
| show | firstName | First name |
| show | goBack | Button to return to the cart |
| show | image | Page image |
| show | invoiceRecipient | Recipient code or PEC address for electronic invoice new |
| for | items | Product SKUs being ordered. It is the same as the cart.html page |
| show | lastName | Last name |
| show | mobileNumber | Mobile number |
| show | order | Button to confirm and place the order |
| for | payments | Payment methods |
| show | paymentCost | Payment cost, for example due to a fee or cash on delivery |
| show | personalCode | Tax code |
| show | phoneNumber | Phone number |
| show | postalCode | Postal code |
| show | prediscountSubtotal | Total cost before applying any discount |
| for | processings | Processings |
| show | requests | Form the customer can fill in with specific requests about the product. Present only if it is a quote |
| show | shipCity | Shipping city |
| show | shipCountry | Shipping country |
| show | shipName | Shipping recipient name |
| show | shippingCost | Shipping cost |
| for | shippings | Shipping methods |
| show | shipPostalCode | Shipping postal code |
| show | shipStateProv | Shipping province |
| show | shipStreet1 | Shipping street |
| show | shipStreet2 | Shipping street, second line |
| show | shipToAnotherAddress | Checkbox to ship to an address different from the billing address |
| show | stateProv | Province |
| show | statusMessage | Message informing about any errors in form completion |
| show | street1 | Street |
| show | street2 | Street, second line |
| show | taxes | Total taxes amount |
| show | title | Page title |
| if | toQuote | Indicates whether the cart is a quote |
| show | total | Total |
| show | totalCost | Total cost |
| show | weight | Total line weight |
for processings
The processings variable shows the processings visible on the site.
| Instruction | Variable | Description |
|---|---|---|
| show | consent | Checkbox to accept consent for processing |
| show | description | Processing description |
| show | id | Unique processing identifier |
| if | isConsentRequired | Indicates whether consent is required |
| show | moreInfo | Link to the details page |
| show | title | Processing title |