Shopify Sandbox Install Instructions

Heather Haleen
Heather Haleen
  • Updated

In this article:

Use the steps below to configure your Sandbox shop properly. 

Warning.png Shopify's sandbox/staging app must be created and installed as a Custom App within the Shopify Dev Dashboard.

Number1.png  Create a new Sandbox app in Shopify

You will create your sandbox app in Shopify and must have Shopify store Admin access to complete this step. It’s recommended a technical person complete this process.

1.    From the Shopify store home page, click Settings in the left menu. 

2.    Next, click Apps in the left menu and then click Develop apps in the upper right. 

Shopify-sandbox-install-new-1.png

Warning.png If you do NOT see the Develop apps button at the top of the page – then you do not have the correct permissions to do this process.

The App development page opens.

Shopify-sandbox-install-new-2.png

3.    Click Build apps in Dev Dashboard to open the Dev Dashboard.

The Apps page opens in a new tab. This is where all of your apps will live.

Shopify-sandbox-install-new-3.png

4.    Click Create App in the upper right to create a Shopify app for testing.

The Create an app page opens and prompts you to enter an app name. 

Shopify-sandbox-install-new-4.png

5.    Add a name for your new Sandbox store app on the right side in the App name field. Do not use Whiplash in your app name because it could create confusion. Your app name should be something that is descriptive and clear so others easily recognize it.  

💡 You can use upper and lower case. Do not use spaces but use dashes and underscores instead. It can be up to 30 characters.

Suggested name:  Sandbox-ABC-store 

We recommend you jot down the name because you’ll need this information later on.

6.    Click Create. The Create version page opens.  

Shopify-sandbox-install-new-5.png

7.    On this page, you’ll add several important details for your Sandbox app. 

Field Descriptions & instructions
App URL Required. We recommend leaving the placeholder example URL in this field:  https://example.com 
Embed app in Shopify admin checkbox Use the default (box checked)
Preferences URL Not required. Leave blank.
Webhooks API Version

The version of the Shopify API that RyderShip is currently using.

Select this version from the drop-down:  2026-01 

Your RyderShip onboarding contact [JH2.1][RR2.2]will provide this information to you.

💡 We recommend that you update this field for your Sandbox app each time RyderShip adopts a new Shopify API version[JH3.1][JH3.2][RR3.3]. – if you plan to continue to use this Sandbox app for testing going forward.

So far, we’ve updated only one field on this page:  Webhooks API version

Shopify-sandbox-install-new-6.png

Field Description & instructions
Access – Scopes

Scopes define what your app is allowed to access.  Your required scopes for RyderShip include:

write_products, read_products, write_orders, read_orders, write_fulfillments, read_fulfillments, read_customers, read_locations, read_inventory, write_inventory, read_assigned_fulfillment_orders, read_draft_orders, read_merchant_managed_fulfillment_orders, read_order_edits, write_merchant_managed_fulfillment_orders, write_third_party_fulfillment_orders, read_third_party_fulfillment_orders, write_assigned_fulfillment_orders

a)    Copy (Ctrl + C) the above comma-separated list and paste it (Ctrl + V) in the Scopes field. 

Shopify-sandbox-install-new-7.png

b)    Click the Select Scopes link to verify that the correct Scopes have been selected.

Shopify-sandbox-install-new-8.png

c)    Scroll through the list to verify that all have been checked. They’re added here for easier readability.

•    write_products
•    read_products
•    write_orders
•    read_orders
•    write_fulfillments
•    read_fulfillments
•    read_customers
•    read_locations
•    read_inventory
•    write_inventory
•    read_assigned_fulfillment_orders
•    read_draft_orders
•    read_merchant_managed_fulfillment_orders
•    read_order_edits
•    write_merchant_managed_fulfillment_orders
•    write_third_party_fulfillment_orders
•    read_third_party_fulfillment_orders
•    write_assigned_fulfillment_orders

If any are missing, be sure to mark the checkbox to select them.

Shopify-sandbox-install-new-9.png

d)    Click Done when your Scopes list is complete. 

Optional Scopes Not required. Leave blank.
Redirect URLs Not required. Leave blank.
POS Not required. Leave blank.
App proxy Not required. Leave blank.


8.    Once your settings look good, click Release at the top or bottom of the page. 

Shopify-sandbox-install-new-10.png

This pop-up opens. 

Shopify-sandbox-install-new-11.png

You do not need to enter anything on this pop-up. A version name will be auto-generated. 

9.    Click Release again to confirm.

Shopify-sandbox-install-new-12.png

Your new Sandbox app has been added. If you have multiple versions, your most current one is listed as Active.

10.    To view an Overview page for your app, click your app name at the top of the left menu.

Shopify-sandbox-install-new-13.png

11.    Click Install app in the Installs section.

This page opens showing your Shopify store – not your Sandbox app. 

Shopify-sandbox-install-new-14.png

12.    Click your store name to open the Install app page. 

Shopify-sandbox-install-new-15.png

13.    Click Install. 

The Example Domain page displays, and your sandbox app has been installed.

Shopify-sandbox-install-new-16.png

14.    To start STEP 2:  Submit a ticket by emailing support@whiplash.com with the information listed below. Be sure to cc: your onboarding contact on the ticket:

  • Shopify store domain – the domain name located under your primary Shopify store name. The domain name may not match your primary Shopify store name, so it’s critical to provide this information to RyderShip.

Example domain:  abc-store.myshopify.com

Shopify-sandbox-install-new-17.png

  • Shop Name – the name you entered when creating your Sandbox app. See below to locate this. 
  • Client ID – this value is located on the Dev Dashboard’s Settings page. See below to locate this.
  • Client Secret – this value is located on the Dev Dashboard’s Settings page. See below to locate this.

Warning.png The Client ID and Secret were both generated during the Dev Dashboard app (sandbox) creation process and will be used by RyderShip to retrieve your token, which is needed in STEP 2. 

To locate your Shop Name, Client ID and Client Secret values, use these steps:

a.)  From the Example Domain page, click Settings in the lower left of the page.

Shopify-sandbox-install-new-17-2.png

b.)   Click Apps in the left menu. Click Develop apps.

Shopify-sandbox-install-new-18.png

c.)   Next, click Build apps in Dev Dashboard to open the Dev Dashboard. Your Sandbox Shop name displays.

Shopify-sandbox-install-new-19.png

d.)   Click your sandbox shop app name, and then select Settings from the left menu. Your Client ID and Client Secret values display.  Use the eyeball icon to display the Secret value.

Shopify-sandbox-install-new-20.png

Displaying the values will help you to easily copy/paste so you can send them to RyderShip for the Tech team to use in STEP 2

 Back to top

Number2.png  RyderShip connects the Sandbox store app to RyderShip 

1.   First, the RyderShip team must connect the RyderShip Sandbox environment and your new Shopify Sandbox app, using the information that you included in your ticket. 

2.   You’ll receive confirmation from your onboarding contact when your sandbox shop app is available in the RyderShip Sandbox environment.

Next, you need to view your sandbox shop app in the RyderShip Sandbox:

1.   Open the RyderShip Sandbox environment.

2.   Click the drop-down under Customer, and then click Preferences.

3.   Click the Shops tab. Your store domain that is connected to your sandbox app displays. 

Shopify-sandbox-install-new-21.png
We recommend that you verify your shop connection on the Shop Info page in RyderShip.

4.    Click the Diagnostics link on the Shopify page.

Shopify-sandbox-install-new-22.png

The Shop Info and Shopify Locations page opens.

Shopify-sandbox-install-new-23.png

5.   Verify the following:

  • Whiplash is in the name of your Shopify Location 
  • The Whiplash location is Set to sync from this location (green). 

6.    Move onto STEP 3

Back to top

Number3.png Complete your Shopify Sandbox setup

1.  In your Shopify app, open your Shopify home page and click Settings in the lower left menu.

Shopify-sandbox-install-new-24.png

The General page opens. 

Shopify-sandbox-install-new-25.png

2.  Click Shipping and delivery in the left menu, and open the Order Routing drop-down to add a rule.

Shopify-sandbox-install-new-26.png

Three routing rules have already been created as part of the install process. 

3.   Click the arrow as shown below to open the Order Routing page.

Shopify-sandbox-install-new-27.png

4.   On the Order Routing page, click Add rule.

Shopify-sandbox-install-new-28.png

The Add rule page opens.

5.   Click the Use ranked locations + icon. 

Shopify-sandbox-install-new-29.png

The Add rule page opens with Use ranked locations selected.

Shopify-sandbox-install-new-30.png

6.   Click the Add location group link to add a new location group. 

Shopify-sandbox-install-new-31.png

A new, blank location group opens.

Shopify-sandbox-install-new-32.png

7.   Drag and drop the Whiplash location into the new Location group section. 

Shopify-sandbox-install-new-33.png

8.   Next, click the 6-dot icon next to the Location group to move the new Whiplash location group to the top of the list of locations. This will make Whiplash the top priority location group.

Shopify-sandbox-install-new-34.png

Your Whiplash location should be at the top.  

Shopify-sandbox-install-new-35.png

9.   Click Done.

Your sandbox setup is complete! 

Contact your RyderShip onboarding contact to determine next steps.

Back to top

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request