Configure Checkout Step Properties

This topic applies to

Applies to

SuiteCommerce Advanced

Use the following properties when configuring each checkout step. Set these properties in the applicable Checkout Steps configuration file.

  • name (string): specifies the literal name for the step as it appears in the breadcrumb.

  • getName (function): specifies the dynamic name for the step as it appears in the breadcrumb. If this property is not defined, the default is the name property.

  • url (string): specifies the url for the step. This property is required and must be unique among all steps.

  • continueButtonLabel (string): specifies the label of the Continue button for the step. If not specified, the default is Continue.

  • hideBackButton (boolean): specifies if the Back button appears on the site or not. If set to true, the button is hidden for this step. If not specified, the default is false.

  • hideContinueButton (boolean): specifies if the Continue button appears on the site or not. If set to true, the button is hidden for this step. If not specified, the default is false.

  • hideSecondContinueButtonOnPhone (boolean): specifies if the second Continue button displays on a smart phone or not. If set to true, the button is hidden for this step. If not specified, the default is false. Use this if there are too many Continue buttons in a step, such as the top, bottom and summary buttons).

  • hideSummaryItems (boolean): specifies if the cart summary’s items are shown on this step or not. If set to true, the item is hidden for this step. If not specified, the default is false.

  • hideBreadcrumb (boolean): specifies if the page’s breadcrumb is shown on this step or not. If set to true, the button is breadcrumb for this step. If not specified, the default is false.

  • headerView (string): specifies the main site header defined for the step. If not defined, the simplified header is used. You can define the normal 'header' or a custom one.

  • footerView (string): specifies the main site footer defined for the step. If not defined, the simplified footer is used. You can define the normal ‘footer’ or a custom one.

  • bottomMessage (string): defines a message to display at the bottom of the step above the Continue and Back buttons. If not specified, the default is no message.

  • isActive (function): specifies if the entire step is active (shown) or not, based on one or more conditions. The default implementation returns true. It is not required that all modules are active.

  • save (function): is a custom save function that finishes the wizard and saves the configuration. When used within this module, this property calls the submit function.

  • present (function): lets you customize the step to perform some action, such as trigger Google Analytics tracking.

  • modules (array): defines an array of modules used for the step.