Extensibility Component Classes

This topic applies to

Applies to

SuiteCommerce Web Stores | Aconcagua

A component is piece of functionality in a SuiteCommerce application that connects with specific aspects of the application to accomplish a task. The Extensibility API is organized around these components. Each component includes an associated class and various exposed methods for obtaining or modifying data, views, or template context.

The following components classes are currently available using the Extensibility API:

For more information on how to use these components when building extensions, see Extensibility API Tutorials.

ProductDetailsPageComponent

ID: PDP

This component interacts entirely with the Product Details page. This accesses objects inside the Product Details View only. This is undefined if invoked from any other part of the application.

CartComponent

ID: Cart

This component interacts entirely with the LiveOrder, allowing you to add, update, and remove lines from the order, apply promotions to the order, select a shipping method to the order, associate the shipping and billing address to the order, add payment methods, etc. This component can access objects available in all three ssp applications: shopping, myaccount and checkout.

This component is available in the Frontend and the Backend. 

ProductListPageComponent

ID: PLP

This component interacts entirely with the Search Page, allows navigating to the next or previous page, set the current page, change the rendering, search for a product, get the last search term,etc. This component accesses objects inside the Facets Browse View in the shopping application only. This is undefined if invoked from any other part of the application.

CheckoutComponent

ID: Checkout

This component interacts entirely with the Checkout page and the checkout steps flow. This component lets you modify the steps visually, such as adding, removing, and reordering steps, etc. This component can access objects available in the checkout application only.

EnvironmentComponent

ID: Environment

This component is general to the entire SuiteCommerce Application and provides the utils method and access to Configuration values. This component does not provide interaction with any particular view. This component can access any object available in all three ssp applications: shopping, myaccount and checkout.

CMSComponent

ID: CMS

This component is created only for the purpose of registering new Custom Content Types. If you want to add views inside of your CCT you can interact with all the rest of the components available. This component can access objects available in all three ssp applications: shopping, myaccount, and checkout.

LayoutComponent

ID: Layout

This component gives you an option for modifying an aspect of SuiteCommerce , but do not have a specific component available. For example, no components currently exist that let you add or modify views on the Home Page, the Header, Footer, or MyAccount. Using Layout, you can access all the view methods for each view (addChildViews, addChildView, removeChildView, etc.). As more components become available in future SuiteCommerce updates, you can simply replace the use of Layout for the appropriate (new) component, keeping the same methods.