Loading...

Checkout API

Methods
RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.

get_windowPlaceholder()

Returns the modal window associated with the widget.

Example-get_windowPlaceholder()

tpc.page.TpcCheckout.get_windowPlaceholder()
Parameters

Returns

jQuery Object

get_orderSummaryPlaceholder()

Returns the div of the order summary.

Example-get_orderSummaryPlaceholder()

tpc.page.TpcCheckout.get_orderSummaryPlaceholder()
Parameters

Returns

jQuery Object

get_kendoWindow()

Returns the Kendo Window Object associated with the widget.

Example-get_kendoWindow()

tpc.page.TpcCheckout.get_kendoWindow();
Parameters

Returns

Object

get_personalInformationContainer()

Returns the div of the contact information.

Example-get_personalInformationContainer()

tpc.page.TpcCheckout.get_personalInformationContainer();
Parameters

Returns

jQuery Object

get_errorContainer()

Returns the error containing div. 

Example-get_errorContainer()

tpc.page.TpcCheckout.get_errorTemplate();
Parameters

Returns

jQuery Object

toggle()

Toggles the visibility of the widget.

Example-toggle()

tpc.page.TpcCheckout.toggle();

Parameters

Returns

None

get_shippingAddressContainer()

Returns the div of the shipping address.

Example-get_shippingAddressContainer()

tpc.page.TpcCheckout.get_shippingAddressContainer();
Parameters

Returns

jQuery Object

get_postPaymentOrderSummaryTemplate()

Returns the kendo template for the element containing order summary of the widget.

Example-get_postPaymentOrderSummaryTemplate()

tpc.page.TpcCheckout.get_postPaymentOrderSummaryTemplate();
Parameters

Returns

jQuery Object

get_type()

Returns the type of widget it is. Can be used in conjunction with findAll() e.g., tpc.findAll()[0].get_type().

Example-get_type()

tpc.page.TpcCheckout.get_type();
Parameters

Returns

String

get_model()

Returns the model configuration object of the widget, which contains several useful properties related to the widget.

Example-get_model()

tpc.page.TpcCheckout.get_model();
Parameters

Returns

Object

get_shippingMethodOptionsContainer()

Returns the div of the shipping method options.

Example-get_shippingMethodOptionsContainer()

tpc.page.TpcCheckout.get_shippingMethodOptionsContainer();
Parameters

    

Returns

jQuery Object

show()

Shows the widget on the page.

Example-show()

tpc.page.TpcCheckout.show();
Parameters

Returns

None

get_kendoValidator()

Gets the kendo configurations on the checkout widget.

Example-get_kendoValidator()

tpc.page.TpcCheckout.get_kendoValidator();
Parameters

Object

Returns

get_container()

Returns the container element of the widget.

Example-get_container()

tpc.page.TpcCheckout.get_container();
Parameters

Returns

jQuery Object

get_billingAddressContainer()

Returns the billing address div container.

Example-get_billingAddressContainer()

tpc.page.TpcCheckout.get_billingAddressContainer();
Parameters

Returns

jQuery Object

get_checkoutPlaceHolder()

Returns the checkout div containing the contact, billing and shipping info.

Example-get_checkoutPlaceHolder()

tpc.page.TpcCheckout.get_checkoutPlaceHolder();
Parameters

Returns

jQuery Object

hide()

Hides the widget from the page.

Example-hide()

tpc.page.TpcCheckout.hide();
Parameters

Returns

None

add_paymentButtonClick(selector, clickEvent)

Method adds a click event to any element inside the checkout placeholder. The selector parameter takes a CSS selector on a custom button. The clickEvent parameter is an anonymous method that gets triggered by a click.

Example-add_paymentButtonClick(selector, clickEvent)

tpc.page.TpcCheckout.add_paymentButtonClick(".customPay ",function(){alert("hello")});

Parameters

String and Function

Returns

None