Sample Application FAQ

Overview

The Commerce Storefront Sample Application demonstrates how to build a storefront experience using our latest Commerce Platform innovations. Using the sample application, developers can quickly learn how to build apps with the Salesforce Commerce Node.js SDK and the Salesforce Commerce API.

The sample application currently shows an example implementation for homepage, product list page, product detail page, and cart. These implementations help development teams quickly understand how to use these technologies and begin their own journey of building amazing commerce experiences.

Learn more about the sample application in the README.

Answers to Common Questions

What technologies does the sample application use?

The sample application’s back end is built on the new Salesforce Commerce API (a RESTful headless API). The front end is built with Lightning Web Components (LWC). In between, the sample application uses GraphQL and the Salesforce Commerce Node.js SDK.

Read more about the sample application architecture.

What is the difference between the sample application and Storefront Reference Architecture (SFRA)?

  • The sample application provides an example implementation for building a storefront using our latest Commerce Platform innovations. However, the sample application is not a complete and fully functional storefront reference application.
  • The sample application does not replace, or have full feature parity with, SFRA. The sample application does not cover (or test) important use cases covered by SFRA, so it’s not production ready.
  • The sample application, unlike SFRA, is not meant to be an out-of-the-box production storefront application. The sample application is meant to give you some guidance and understanding about how to get started with the Salesforce Commerce API and the Salesforce Commerce Node.js SDK. However, it is not intended to be a starting point to launch your storefront.

Is the sample application a replacement for SFRA?

No, the sample application is not a replacement for SFRA, and it is not meant to deprecate SFRA. See the section on differences between the sample application and SFRA.

What’s missing from the sample application?

Some of the features that prevent the sample application from being a production-ready application are:

  • Authentication: Required for a fully functional cart and checkout experience.
  • CMS Integration: Required to customize the storefront experience per user.
  • Server-side Rendering: Required for product listing search engine optimization.
  • Component Portability: Work needs to be done to re-use components outside of the sample app context.
  • Localization: Currently Sample Application supports only English as language option.

What is the Salesforce Commerce API?

The Salesforce Commerce API is a new RESTful API for Salesforce B2C Commerce. The API provides access to the B2C Commerce resources so that developers can create commerce experiences anywhere.

You can explore the full capabilities of this API with the API Reference.

What is the Salesforce Commerce Node.js SDK?

The Salesforce Commerce Node.js SDK is an open source SDK built using TypeScript and Node.js. The SDK can access all the endpoints of the Salesforce Commerce API.

If I use the sample application as the basis for my storefront, can I expect full support from Salesforce for a bug or enhancement?

No. The sample application is not meant to be used as a starting point for a storefront. Any code that you copy becomes your code, and you take full and complete ownership of it. Support will be provided for the SDK and Commerce API only. However, we still encourage you to provide feedback on the GitHub repository.