Store Configuration

Introduction

This guide will walk you through the steps to configure your Shopify, BigCommerce or Adobe Commerce Store for Shogun Frontend.

Shopify

Create a private app in Shopify

  1. If you haven't already, create a store in Shopify.

🚧

Note

Some stores might use different terms for the steps in this guide. Check the table below:

OldNew
Shared SecretAPI secret key
PasswordAdmin API access token

🚧

Developer preview should not be enabled when creating a development store in Shopify. Doing so will prevent connecting the domain.

  1. Go to <<<https://{your-store}.myshopify.com/admin/apps>>>.
  2. Navigate to Apps > App and sales channel settings > Develop apps.

  1. Click Create an app.
  2. App name: Shogun Frontend
  3. App developer email: [email protected] — this needs to be added as collaborator to your store.
  4. Click Create app.
  5. Next, configure the Admin API scopes and Storefront API scopes.

  1. For Admin API scopes, select the following and click Save:
  • Add inventory permissions: ADMIN API PERMISSIONS > Inventory > Read access
  • Add product permissions: ADMIN API PERMISSIONS > Products > Read access
  • Add product listing permissions: ADMIN API PERMISSIONS > Product listings > Read access

  1. Go back to Configuration, check all items under Storefront API access scopes and click Save.

  1. Click Install app
  2. Make a note of the Admin API access token, API secret key and Storefront Access Token.


📘

Products need to be published on the Shogun Frontend sales channel in order to pull into our CMS.

Persist users logged state

Follow the steps below to prevent users from being logged out when they go to the checkout page.

📘

  1. Log in to your Shopify store admin.
  2. Go to Online Store > 'Preferences'.
  3. Uncheck Enable Google reCAPTCHA on login, create account and password recovery pages.

Checkout experience

📘

Your checkout experience should be on a dedicated subdomain to avoid potential downtime. For example, a store using a domain like www.example.com should use a subdomain such as checkout.example.com or shop.example.com.

Send Shogun Necessary Information

Internal store set ups should be routed through the engineering team.

Send the following to any member of the Support team at Shogun via One Time Secret.

  1. Shopify Platform Domain i.e.  <<<https://{your-store}.myshopify.com>>>.
  2. Admin API access token (shpat_*).
  3. Admin API secret key (shpss_*).
  4. Storefront access token (at the bottom).

📘

Note: this is not the same as the API key!

  1. User emails that require access.

📘

Note: Must be Google email accounts!

  1. /<checkout_id>/checkouts/... Checkout ID from URL in the checkout page.


BigCommerce

Create New API Account

  1. Click Advanced Settings from the lefthand sidebar menu.
  2. Select API Accounts at the bottom of the list.
  3. Create New API Account
  4. Select v2/v3 Account.
  5. Name the API [StoreName] - ShogunFrontend and Save.
  6. Update permissions for the following options
    • Customers: Modify
    • Orders: Read Only
    • Products: Read Only
    • Carts: Modify
    • Checkout: Modify
    • Storefront API Tokens: Manage
  7. Click Save and a text file with the following information will automatically download to your computer with the following information:
    • Access token
    • Client ID
    • Clients Secret
    • Name
    • API Path

Send Shogun Necessary Information

  1. Please send us the text file along with the following information (via One Time Secret):
    • BigCommerce platform domain URL
    • Current live store domain
    • Names & emails for users that need access to the Shogun Frontend Store

📘

Note: Must be Google email accounts!

Adobe Commerce (Magento)

Create new API Integration

  1. Click System
  2. Under Extensions, click Integrations
  3. Click Add New Integration
  4. Under Integration Info:
    • Name the integration “Shogun Frontend”
    • Callback URL and Identity link URL can be left blank
  5. Under API, select the following endpoints to provide access to:
    • Catalog (without Edit permission)
    • Carts
    • Stores
  6. Save
  7. Once your integration has been created, click Activate, then Allow
  8. Note your Access Token

Install the Checkout Extension

In order to connect checkout, please install this PHP package on your Adobe Commerce (Magento) instance following our documentation here.

Provide Access

In order to efficiently troubleshoot, we need access to your Adobe Commerce (Magento) store.

  1. Click System
  2. Under Permissions, click All Users
  3. Click Add New User
  4. Please configure the following fields:
  5. Password: generate a password and send it per instructions below
  6. When setting the Role, ensure:
    • Role Scope is set to All
    • Role Resource has at least the following folders selected: Catalog, Customers, Carts, Stores, System

Inventory Management

To display products that are out of stock, you will need to enable the following “Display Out of Stock Products” option.

Go to Stores > Configuration > Catalog > Inventory > Stock Options and enable "Display Out of Stock Products"

If the options is disabled, any query will not return the item you are looking for.

Send Shogun Necessary Information

Please send the following information via One Time Secret to Shogun Support here.

  • Access Token from above step
  • New User Password from above step
  • The names and emails that need access the Shogun Frontend Site
  • And finally, the domain of your Adobe Commerce (Magento) Site, found here:

📘

Note: Must be Google email accounts!


What’s Next