cs-icon.svg

Elastic Path App Installation Guide

Elastic Path Commerce Cloud is a flexible, cloud-based e-commerce platform designed for enterprises that need to create highly customized, scalable, and innovative digital commerce experiences. It is a headless API-driven platform that can be integrated with various front-end technologies, such as web and mobile applications, to create customized and engaging digital storefronts.

With the Contentstack Marketplace Elastic Path Commerce Cloud app, you can add products and hierarchies from your Elastic Path Commerce Cloud account within your Contentstack entries. You can also view the product details and search for the selected products directly in the Sidebar Widget.

Prerequisites

  • Elastic Path Commerce Cloud account
  • Contentstack account
  • Access to the Contentstack Organization/Stack as the Owner/Admin

This step-by-step guide explains how to install and configure the Elastic Path Commerce Cloud app within your stack.

The steps to be performed are as follows:

  1. Retrieve Configuration Details from Elastic Path Commerce Cloud
  2. Install and Configure Elastic Path Commerce Cloud in Contentstack Marketplace
  3. Use Elastic Path Commerce Cloud within your Stack
  1. Retrieve Configuration Details from Elastic Path Commerce Cloud

    To get your configuration details for Elastic Path Commerce Cloud, follow the steps given below:

    1. Log in to the Elastic Path Portal using your Elastic Path Commerce Cloud account credentials.
    2. Select your store from a list of stores you have created before. 
    3. EPCC_-_Stores_List.png
    4. Alternatively, you can create a new store. To do this, follow the steps below:
      1. Click the Create new store button.
      2. Enter the name of the store.
      3. Click the Create button.
    5. EPCC_-_Create_Store.png
    6. To integrate Elastic Path Commerce Cloud in Contentstack, we need the Login Base URL, API Base URL, Client ID, and the Client Secret of the store. To retrieve these values, under the System options, click Application Keys in the left panel.
    7. EPCC_-_Application_Keys.png

      Note: Elastic Path Commerce Cloud provides you with your Login Base URL when you sign up.

    8. To create new Application Keys, click the Create New button.
    9. EPCC_-_Create_New_key.png
    10. In the new screen, enter the name of the Application Key and click the Create button.
    11. EPCC_-_Key_Name.png
    12. The new Application Key is generated. A pop-up displays the Client Secret.

    13. Note: Since the Client Secret is confidential, it is displayed only once. In case you do not copy it to your clipboard, you will need to create a new Application Key.

    14. Click the Copy Client Secret button to copy the Client Secret.
    15. EPCC_-_Client_Secret.png

      Note: Keep the Client Secret safe for future use. 

    16. Click the Dismiss button.
      You can see your API Base URL, Client ID, and Client Secret displayed on the screen.
    17. Click the copy icon next to the API Base URL and Client ID to store the values for future use. 
    18. EPCC_-_API_ID_Secret_Key.png

      Repeat the process from Step 5 if you want to add more Application Keys to your store.

    19. Now click Application Keys in the left panel to see the list of all Application Keys generated for your store. 
    20. EPCC_-_Application_Keys_list.png
  2. Install and Configure Elastic Path Commerce Cloud in Contentstack Marketplace

    To install the application in Contentstack, follow the steps below:

    1. Log in to your Contentstack account.
    2. In the left-hand side primary navigation, click the Marketplace icon to go to the Marketplace. 
      Marketplace-Icon.png
    3. Click Apps from the left panel.
    4. Within the Marketplace, you can see all the available apps. Hover over the Elastic Path Commerce Cloud app and click the Install App button.
      Elastic-Path-App.png
    5. In the popup window, select the stack where you want to install the Elastic Path Commerce Cloud app and click the Install button.
      Elastic-Path-Install-App
    6. On the Configuration screen, enter the following details retrieved from your Elastic Path Commerce Cloud Account:
      1. Login Base URL: The URL used to log in to the Elastic Path Commerce Cloud account.
      2. API Base URL: The API Base URL retrieved from the Elastic Path Commerce Cloud account.
      3. Client ID: The Client ID retrieved from the Elastic Path Commerce Cloud account.
      4. Client Secret: The Client Secret retrieved from the Elastic Path Commerce Cloud account.
      5. Save in Entry: Choose how to save the data fetched from Elastic Path Commerce Cloud in Contentstack entries.
        1. If you select All Fields, you can select only a limited number of products.
        2. For Custom Fields, you can search and add specific Elastic Path Fields you want to save in entries. By default, the id and name of the products are selected.
      6. Items per Page: Enter the number of products and hierarchies to display in the selector page based on the hierarchies or catalog filters or upon search or refresh.
      Elastic-Path-Config-Screen.png
    7. Click the Save button.
    8. Click the Open Stack button to start using the Elastic Path Commerce Cloud application.
  3. Use Elastic Path Commerce Cloud within your Stack

    To use the Elastic Path Commerce Cloud application within an entry of your stack, follow the steps given below:

    1. Go to your stack, click the Content Models icon in the left navigation panel, and click the + New Content Type button.
    2. Create a content type by adding relevant details as displayed below: 
      Elastic-Path-Content-Type.png
    3. In the Content Type Builder page, add a Custom field for hierarchy in your content type by clicking the Insert a field link represented by a + sign.
    4. Under Select Extension/App, select Elastic Path - Hierarchy Field and click the Proceed button. 
      Elastic-Path-Hierarchy-Field.png
    5. Add another Custom field for product in your content type by clicking the Insert a field link represented by a + sign.
    6. Under Select Extension/App, select Elastic Path - Product Field and click the Proceed button. 
      Elastic-Path-Product-Field.png
    7. After adding the custom fields for the app, click Save or Save and Close to save your changes. 
      Elastic-Path-Custom-Fields.png
    8. In the left navigation panel, navigate to the Entries page and click + New Entry to create a new entry for the above content type. And then click Proceed.
      You will see the Elastic Path Commerce Cloud app's custom fields on your entry page, as shown below: 
      Elastic-Path-Sample-Entry.png
    9. Click the Add Hierarchy(ies) button, select the hierarchies from your Elastic Path Commerce Cloud store, and add them to your entry. 
      Elastic-Path-Hierarchy-Selector-Page.png
    10. Note: You can filter hierarchies by catalog or by a full-text search based on ID or name.

      The hierarchies you selected are referenced within your entry.

      Elastic-Path-Hierarchy-Added.png
    11. To remove the selected hierarchy, hover over the hierarchy and click the Remove icon.
      Elastic-Path-Hierarchy-Remove.png
    12. Click the Save button to save your entry.
    13. Click the Add Product(s) button, select the products from your Elastic Path Commerce Cloud store, and add them to your entry. 
      Elastic-Path-Product-Selector-Page.png
    14. Note: You can filter products by catalog and hierarchies or by a full-text search based on SKU or name.

      The products you selected are referenced within your entry in the thumbnail view:

      Elastic-Path-Product-Added-Thumbnail-View.png

      To view the products in list view, select the list view option from the dropdown as given below:

      Elastic-Path-Product-View-Options.png

      The products you selected are referenced within your entry in the list view:

      Elastic-Path-Product-Added-List-View.png
    15. To reorder, open in Elastic Path Commerce Cloud or delete the selected product, hover over the product to get the options available, then perform the following:
      1. Click the Reorder icon to drag and reorder the product.
      2. Click the Open in Elastic Path Commerce Cloud icon to open the product in the Elastic Path Commerce Cloud app.
      3. Note: Ensure that you are logged in to your Elastic Path Commerce Cloud account and have selected the store which contains all the imported products.

      4. Click the Delete icon to delete the product.

    16. Thumbnail View

      Elastic-Path-Product-Added-Thumbnail-View-Features.png

      List View

      Elastic-Path-Product-Added-List-View-Features.png
    17. Click the Save button to save your entry.
    18. You can view more product details in the Sidebar Widget.

      Note: You must save your entry to get the product details in the Sidebar Widget.

    19. In the right navigation panel, select Widgets, and then select Elastic Path Commerce Cloud to view the product details. 
      Elastic-Path-Sidebar-Widget.png
    20. Enter the product name in the dropdown to search and view the product details. 
      Elastic-Path-Sidebar-Widget-Search.png
    21. Click the Publish button to publish your entry.
Was this article helpful?
^