Checkout
Short description
This section contains information on the functions and variables for designing the order process, e.g. shopping cart, invoice address and the selection of the payment method.
Global Template Functions
-
BasketItemPriceSelect — Returns the possibility to select a price set of an item in the shopping cart.
-
BasketItemPriceSelectName — Returns the form name for selecting the price set of an item in the shopping cart.
-
BasketItemQuantityInput — Returns the form field for entering the quantity of an item in the shopping cart.
-
BasketItemQuantityInputName — Returns the name of the form field for entering the quantity of an item in the shopping cart.
-
BasketProceedOrderButton — Returns a button that redirects customers to the order overview once they have placed an item in the shopping cart.
-
BasketProceedShoppingButton — Returns a button that returns customers to the item page once they have placed the item in the shopping cart.
-
ButtonBasketSave — Returns a button for saving changes made to the items in the shopping cart.
-
CheckoutAgeRestrictionCheckbox — Returns the check box for confirming the age.
-
CheckoutAmazonPaymentsAdvancedButton — Returns the button for Amazon Payments Advanced.
-
CheckoutAmazonPaymentsButton — Returns the button for Amazon Payments.
-
CheckoutFormSaveButton — Returns a button for saving a form within the order process.
-
CheckoutKlarnaTermsAndConditionsCheckbox — Returns a check box for accepting the Klarna terms and conditions.
-
CheckoutNewsletterCheckbox — Returns a check box for subscribing to a newsletter.
-
CheckoutNextOrderStepOrderButton — Returns a button that takes customers to the next step of the order process.
-
CheckoutPayPalExpressButton — Returns a button for PayPal Express Checkout.
-
CheckoutPayoneDirectDebitMandateCheckbox — Returns a check box for accepting the PAYONE debit order.
-
CheckoutPayoneInvoiceCheckbox — Returns a check box for accepting the PAYONE credit rating by Klarna.
-
CheckoutPostPayButton — Returns a button for the external checkout via POSTPAY.
-
CheckoutPreviousOrderStepOrderButton — Returns a button that takes customers to the previous step of the order process.
-
CheckoutPrivacyPolicyCheckbox — Returns a check box for accepting the privacy rights.
-
CheckoutStepPageID — Returns the ID of the category for the order process step passed.
-
CheckoutTermsAndConditionsCheckbox — Returns a check box for accepting the general terms and conditions.
-
CheckoutWithdrawalCheckbox — Returns a check box for accepting the cancellation rights.
-
Container_CheckoutBasketItemsList — Returns the content of the list of items in the shopping cart. The content is defined in the CheckoutBasketItemsList template.
-
Container_CheckoutCoupon — Returns the content of the coupon container. The content is defined in the CheckoutCoupon template.
-
Container_CheckoutCustomerInvoiceAddress — Returns the content of the invoice address container. The content is defined in the CheckoutCustomerInvoiceAddress template.
-
Container_CheckoutCustomerShippingAddress — Returns the content of the delivery address container. The content is defined in the CheckoutCustomerShippingAddress template.
-
Container_CheckoutCustomerShippingAddressList — Returns the content of the container for the list of delivery addresses. The content is defined in the CheckoutCustomerInvoiceAddressList template.
-
Container_CheckoutMethodsOfPaymentList — Returns the content of the container for the list of payment methods. The content is defined in the CheckoutMethodsOfPaymentList template.
-
Container_CheckoutOrderConfirmation — Returns the content of the order confirmation container. The content is defined in the CheckoutOrderConfirmation template.
-
Container_CheckoutOrderParamsList — Returns the content of the container for selecting order characteristics.
-
Container_CheckoutScheduler — Returns the content of the subscription container. The content is defined in the CheckoutScheduler template.
-
Container_CheckoutShippingCountriesList — Returns the content of the container for the list of countries of delivery. The content is defined in the CheckoutShippingCountriesList template.
-
Container_CheckoutShippingProfilesList — Returns the content of the container for the list of shipping profiles. The content is defined in the CheckoutShippingProfilesList template.
-
Container_CheckoutTotals — Returns the content of the container for the list of total amounts. The content is defined in the CheckoutTotals template.
-
CouponCodeInput — Returns the form field for entering a coupon.
-
CustomerInvoiceAddressAdditional — Returns the form field for entering additional address information.
-
CustomerInvoiceAddressBirthDay — Returns the form field for entering the day of birth in the format "DD".
-
CustomerInvoiceAddressBirthMonth — Returns the form field for entering the month of birth in the format "MM".
-
CustomerInvoiceAddressBirthYear — Returns the form field for entering the year of birth in the format "YYYY".
-
CustomerInvoiceAddressCity — Returns the form field for entering the town.
-
CustomerInvoiceAddressCompany — Returns the form field for entering the company name.
-
CustomerInvoiceAddressCountrySelect — Returns options for selecting the country of delivery.
-
CustomerInvoiceAddressEmail — Returns the form field for entering the email address.
-
CustomerInvoiceAddressEmailRepeat — Returns the form field for re-entering the email address.
-
CustomerInvoiceAddressFaxNumber — Returns the form field for entering the fax number.
-
CustomerInvoiceAddressFirstName — Returns the form field for entering the first name.
-
CustomerInvoiceAddressFormOfAddressSelect — Returns options for selecting the form of address.
-
CustomerInvoiceAddressGuestAccount — Returns a selection box for selecting a guest account.
-
CustomerInvoiceAddressHouseNo — Returns the form field for entering the house number.
-
CustomerInvoiceAddressLastName — Returns the form field for entering the surname.
-
CustomerInvoiceAddressMobileNumber — Returns the form field for entering the mobile phone number.
-
CustomerInvoiceAddressPassword — Returns the form field for entering the password.
-
CustomerInvoiceAddressPasswordRepeat — Returns the form field for re-entering the password.
-
CustomerInvoiceAddressPersonalID — Returns the form field for entering the personal identity number.
-
CustomerInvoiceAddressPhoneNumber — Returns the form field for entering the phone number.
-
CustomerInvoiceAddressPostIdent — Returns the form field for entering the PostNummer.
-
CustomerInvoiceAddressRegisterAccount — Returns a selection box for selecting a registered account.
-
CustomerInvoiceAddressStateSelect — Returns options for selecting the state / province.
-
CustomerInvoiceAddressStreet — Returns the form field for entering the street.
-
CustomerInvoiceAddressVATNumber — Returns the form field for entering the VAT number.
-
CustomerInvoiceAddressZIP — Returns the form field for entering the postcode.
-
CustomerShippingAddressAdditional — Returns the form field for entering additional address information.
-
CustomerShippingAddressCity — Returns the form field for entering the town.
-
CustomerShippingAddressCompany — Returns the form field for entering the company name.
-
CustomerShippingAddressCountrySelect — Returns options for selecting the country of delivery.
-
CustomerShippingAddressEmail — Returns the form field for entering the email address.
-
CustomerShippingAddressFaxNumber — Returns the form field for entering the fax number.
-
CustomerShippingAddressFirstName — Returns the form field for entering the first name.
-
CustomerShippingAddressFormOfAddressSelect — Returns options for selecting the form of address.
-
CustomerShippingAddressHouseNo — Returns the form field for entering the house number.
-
CustomerShippingAddressLastName — Returns the form field for entering the surname.
-
CustomerShippingAddressPhoneNumber — Returns the form field for entering the phone number.
-
CustomerShippingAddressPostIdent — Returns the form field for entering the PostNummer.
-
CustomerShippingAddressRadio — Returns a radio button for selecting the delivery address.
-
CustomerShippingAddressStateSelect — Returns options for selecting the state / province.
-
CustomerShippingAddressStreet — Returns the form field for entering the street.
-
CustomerShippingAddressVATNumber — Returns the form field for entering the VAT number.
-
CustomerShippingAddressZIP — Returns the form field for entering the postcode.
-
FormOpenCheckout — Returns a form element that can be used for sending data from the order process.
-
FormatMonetaryValue — Returns a formatted currency amount.
-
GetCheckoutBasketItemAttributesList — Returns a list of attributes that belong to an item.
-
GetCheckoutBasketItemItemParamsList — Returns a list of characteristics that belong to an item.
-
GetCheckoutBasketItemOrderParamsList — Returns the current order characteristics of a shopping cart item.
-
GetCheckoutBasketItemPriceSetList — Returns a list of price sets that belong to an item.
-
GetCheckoutBasketItemsList — Returns the content of the list of items in the shopping cart.
-
GetCheckoutCoupon — Returns the content of the coupon container.
-
GetCheckoutCustomerInvoiceAddress — Returns an object containing the invoice address data.
-
GetCheckoutCustomerPropertiesList — Returns an object containing the customer characteristics data.
-
GetCheckoutCustomerShippingAddress — Returns an object containing the delivery address data.
-
GetCheckoutCustomerShippingAddressList — Returns an object containing the list of shipping addresses.
-
GetCheckoutMethodsOfPaymentList — Returns an object containing the payment method data.
-
GetCheckoutOrderConfirmation — Returns an object containing the order confirmation data.
-
GetCheckoutOrderParamBasketItemsList — The list of the individual item variations that require order characteristics.
-
GetCheckoutOrderParamGroupsList — The list of required characteristics groups.
-
GetCheckoutOrderParamValuesList — The list of required characteristics.
-
GetCheckoutScheduler — Returns the content of the subscription container.
-
GetCheckoutShippingAddressPostfinder — Returns a HTML container containing a list of Packstations and post offices.
-
GetCheckoutShippingCountriesList — Returns a list of countries of delivery.
-
GetCheckoutShippingCountriesStatesList — Returns a list of a country’s states/counties.
-
GetCheckoutShippingProfilesList — Returns a list of shipping profiles.
-
GetCheckoutTotals — Returns a list of total shopping cart amounts.
-
GetCheckoutTotalsMarkupList — Returns the sum of the characteristics surcharges in the shopping cart.
-
GetCheckoutTotalsVatList — Returns a list of VAT rates and amounts in the shopping cart.
-
GetCheckoutTrustedShopsBuyerProtectionItem — Returns an object for displaying the Trusted Shops buyer protection Excellence item.
-
Link_MethodOfPaymentInfoPage — Returns a link to the info page of a specific payment method.
-
Link_SetMethodOfPayment — Returns a link for setting the payment method.
-
Link_SetShippingCountry — Returns a link for setting the country of delivery.
-
Link_SetShippingProfile — Returns a link for setting the shipping profile.
-
MethodOfPaymentCustomerBirthdateInput — Returns the input option for the customer’s date of birth.
-
MethodOfPaymentSelect — Returns options for selecting the payment method.
-
PlaceOrderButton — Returns a button to complete the order.
-
PostfinderButton — Returns a button for searching Packstations and post offices.
-
SaveCheckoutCouponButton — Returns a button to display in the order overview that allows customers to redeem a coupon.
-
SaveCheckoutSchedulerButton — Returns a button to display in the order overview that allows customers to save a subscription.
-
SaveCustomerInvoiceAddressButton — Returns a button to display in the order overview that allows customers to save the invoice address.
-
SaveCustomerShippingAddressButton — Returns a button to display in the order overview that allows customers to save the shipping address.
-
SchedulerDateInput — Returns the input option for the subscription starting date.
-
SchedulerIntervalSelect — Returns the input option for the subscription interval.
-
SchedulerRepeatingSelect — Returns options for selecting the number of times the subscription order is to be repeated.
-
ShippingCountrySelect — Returns options for selecting the country of delivery.
-
ShippingProfileSelect — Returns options for selecting a shipping profile.
-
SubmitCustomerShippingAddressButton — Returns a button to save the shipping address entered.
Global Template Variables
-
$CheckoutAgeRestrictionCheckboxName — Returns the name attribute value for the check box for the proof of age.
-
$CheckoutBasketIsNet — Specifies whether item prices in the shopping cart are net prices.
-
$CheckoutBasketIsTinyBasket — Specifies whether the short order process applies if the order was placed on eBay.
-
$CheckoutCurrentStep — Returns the number of the current order step.
-
$CheckoutCustomerShippingAddressID — Returns the ID of the current delivery address.
-
$CheckoutCustomerSign — Contains the customer reference.
-
$CheckoutCustomerSignInputName — Returns the name attribute value for the field for entering the customer reference.
-
$CheckoutKlarnaTermsAndConditionsCheckboxInfo
-
$CheckoutKlarnaTermsAndConditionsCheckboxName — Returns the name attribute value for the check box for the Klarna terms and conditions.
-
$CheckoutMethodOfPaymentAdditionalContent — Returns additional content for the current payment method. E.g. additional fields that are directly transmitted by the payment provider.
-
$CheckoutMethodOfPaymentID — Contains the payment method’s ID.
-
$CheckoutMethodOfPaymentRedirectURL — Returns a URL of the current payment provider if this provider requested a redirect.
-
$CheckoutNewsletterCheckboxName — Returns the name attribute value for the check box of the newsletter registration.
-
$CheckoutOrderId
-
$CheckoutOrderInfoText — Contains any additional customer wishes.
-
$CheckoutOrderInfoTextInputName — Returns the name attribute value for the field for entering additional customer wishes.
-
$CheckoutPayoneDirectDebitMandateCheckboxInfo
-
$CheckoutPayoneDirectDebitMandateCheckboxName — Returns the name attribute value for the check box of the PAYONE debit order.
-
$CheckoutPayoneInvoiceCheckboxInfo
-
$CheckoutPayoneInvoiceCheckboxName — Returns the name attribute value for the check box of the PAYONE credit rating via Klarna.
-
$CheckoutPrivacyPolicyCheckboxName — Returns the name attribute value for the check box of the PAYONE debit order.
-
$CheckoutShippingCountryID — Returns the ID of the country of delivery.
-
$CheckoutShippingProfileID — Returns the ID of the delivery address.
-
$CheckoutTermsAndConditionsCheckboxName — Returns the name attribute value for the check box of the general terms and conditions.
-
$CheckoutWithdrawalCheckboxName — Returns the name attribute value for the check box for the cancellation rights.
-
$CouponCodeInputName — Returns the name attribute value for the field for entering the coupon code.
-
$CustomerShippingAddressSelectName — Contains the form name for selecting the delivery address.
-
$FormClosePlaceOrder — Returns a closing form element.
-
$FormOpenPlaceOrder — Returns a form element that can be used for placing the order.
-
$IsCheckoutBasketFSK18
-
$IsCustomerWithOpenOrders
-
$MethodOfPaymentCustomerBirthdateInputName — Contains the form name for entering the date of birth. This is required for some payment methods.
-
$MethodOfPaymentSelectName — Contains the form name for the payment method selection.
-
$MinimumOrderValue — Contains the current client’s minimum order value.
-
$ORDER_PARAMS_GROUP_TYPE_DEFAULT — Type of characteristics group without grouping of the subordinate characteristics.
-
$ORDER_PARAMS_GROUP_TYPE_MULTI — Type of characteristics group with grouping of the subordinate characteristics for multiple selection.
-
$ORDER_PARAMS_GROUP_TYPE_NONE — This type contains characteristics not assigned to any characteristics group.
-
$ORDER_PARAMS_GROUP_TYPE_SINGLE — Type of characteristics group with grouping of the subordinate characteristics for single selection.
-
$ORDER_PARAMS_VALUE_TYPE_EMPTY — Characteristics type "none". Order characteristics of this type should be displayed as check boxes.
-
$ORDER_PARAMS_VALUE_TYPE_FILE — Characteristics type "File".
-
$ORDER_PARAMS_VALUE_TYPE_FLOAT — Characteristics type "Decimal number".
-
$ORDER_PARAMS_VALUE_TYPE_INT — Characteristics type "Integer".
-
$ORDER_PARAMS_VALUE_TYPE_SELECTION — Characteristics type "Selection".
-
$ORDER_PARAMS_VALUE_TYPE_TEXT — Characteristics type "Text".
-
$SchedulerDateInputName — Contains the form name of the subscription order.
-
$SchedulerIntervalSelectName — Contains the form name of the interval selection.
-
$SchedulerRepeatingSelectName — Contains the form name for selecting the number of repetitions.
-
$ShippingCountrySelectName — Contains the form name of the country of delivery selection.
-
$ShippingProfileSelectName — Contains the form name of the shipping profile selection.
-
$TrustedShopsBuyerProtectionCheckboxName — Contains the form name for activating the Trusted Shops buyer protection.