Step 1: Apply the Commerce Starter

Prerequisites

For any of the resources that you apply to your account you will need to have purchased the respective licenses for those products. These products include Pages, Search, and Chat. Any products that your account does not have access to will not be able to be applied to your account; you should be aware of what products you have purchased before applying this starter!

Steps to Apply Whole Starter (All Products)

Depending on the products you wish to apply to your account you will need to remove different resources to align with your products. E.g., if you only want to apply Search, or you want to apply the Knowledge Graph and Pages both, you will need to remove all other resources except for those. Each section below details what resources to keep or remove while applying for each product.

It is highly recommended to apply the Knowledge Graph regardless of the products that you are applying. This pre-populates your account with the necessary entity structure that the products use downstream. This placeholder content can be easily deleted after you have added your own data to the Knowledge Graph.

Installation Instructions

1. Navigate to Apps > Solutions from the left-side navigation bar
2. Click on Commerce Starter Template.
3. Review the overview of the starter and resources included. Then click View Solution to see all resources in the Yext Admin Console. To apply all resources in the template, follow the steps below. Otherwise, proceed to the relevant section below based on what you’d like to apply.
4. In the top right corner, click Apply.
5. Input your account ID, the string of numbers included in any URL of the Yext platform, e.g. https://www.yext.com/s/1234567/apps/solutions.
6. You will likely have to click Start Authorization Flow to allow your account to receive these resources. In the new window, click Authorize.
7. Return to the Admin Console, and click Continue.
8. Review the resources added to your account, and click Continue.
9. Finally, click Confirm to add the new resources to your account!

Steps to Apply Only Knowledge Graph (Entities)

If you wish to only apply sample commerce entities to your account, follow the instructions below:

1. Follow steps 1-3 from the Installation Instructions above.
2. Click the Menu button in the top left corner, and checkboxes will appear next to every resource folder.
3. ONLY check the boxes for the resources commerce-starter-template > default > km and commerce-starter-template > commerce > km.
4. In the top right corner, click Apply.
5. Continue following steps 5-9 from the Installation Instructions above.

Steps to Apply Search

If you wish to only a search experience to your account, follow the instructions below:

1. Follow steps 1-3 from the Installation Instructions above.
2. Click the Menu button in the top left corner, and checkboxes will appear next to every resource folder. ONLY check the boxes for the following resources:
   • commerce-starter-template > default > answers
   • commerce-starter-template > default > pages > repository > actually-purring-moose-eb9d1
   • commerce-starter-template > default > pages > repository > longingly-bursting-teal-253fe
   • commerce-starter-template > default > pages > yextsite-config > search-starter-commerce-react
   • commerce-starter-template > default > pages > yextsite-config > search-starter-commerce-theme
3. In the top right corner, click Apply .
4. Continue following steps 5-9 from the Installation Instructions above.

If you are using the React frontend you will need to replace the placeholder API key and add your business ID in order to make calls to the Search API and populate search results. You will likely see a Page Generation error until these values are updated.

1. Go to your Search General Settings page
2. Copy and paste the API key into the common/consts.ts file in your repo, YOUR_API_KEY.
3. Copy and paste your business ID into the common/consts.ts file in your repo, YOUR_BUSINESS_ID.

Steps to Apply Pages

If you wish to only landing pages to your account, follow the instructions below:

1. Follow steps 1-3 from the Installation Instructions above.
2. Click the Menu button in the top left corner, and checkboxes will appear next to every resource folder.
3. ONLY check the boxes for the following resources:
   • commerce-starter-template > default > pages
   • commerce-starter-template > default > streams
4. Click the trash button to the right of the menu button. Click the menu button once again to remove the check boxes.
5. In the top right corner, click Apply.
6. Continue following steps 5-9 from the Installation Instructions above.

Once the Pages resources are applied in your account you will need to replace the placeholder API keys with your own API keys in order to populate all components on the local store page and category page. To do this:

1. Create a developer app in your account
2. Give this app API permissions: read-only permissions to the Knowledge Graph Endpoints.
3. Once finished, paste the key into the common/consts.ts file in your repo, YOUR_STREAMS_API_KEY.

Steps to Apply Chat

If you wish to only landing pages to your account, follow the instructions below:

1. Follow steps 1-3 from the Installation Instructions above.
2. Click the Menu button in the top left corner, and checkboxes will appear next to every resource folder.
3. ONLY check the boxes for the resource commerce-starter-template > default > chat.
4. In the top right corner, click Apply.
5. Continue following steps 5-9 from Installation Instructions above.

Steps to Apply Analytics

If you wish to only landing pages to your account, follow the instructions below:

1. Follow steps 1-3 from above.
2. Click the Menu button in the top left corner, and checkboxes will appear next to every resource folder.
3. ONLY check the boxes for the resources commerce-starter-template > commerce > analytics.
4. Click the trash button to the right of the menu button. Click the menu button once again to remove the check boxes.
5. In the top right corner, click Apply.
6. Continue following steps 5-9 from Installation Instructions above.