Set up Shopify integration - RPS
This document details how to add a Shopify integration once the client has created the private app API Keys. For an overview of the Shopify integration, please see Shopify Integration
The retailer should have been sent this link Creating the Shopify integration and created the Shopify private app
Add Shopify integration
To open the integration page, click on main menu tab Administration >Third party Integration
2. If a retailer user role is logged in, then they do not have to select any retailer and the page will be redirected to their settings only. The user can see the integration list. At the bottom of the page, there is a list of possible integration images. By clicking on that image user will be redirected to the related integration add/update page.
3. For shopify integration, the user should click on the image with the label "Shopify OmniRPS Private App". If integration is already added, then click on "Update" button to view or update "Shopify OmniRPS Private App" integration from integration list grid.
4. On "Shopify OmniRPS Private App" integration page, the user should provide the following parameters
Integration Name - RetailerName Shopify
Return Action
When the credit will be initiated to ShopifyReturn Creation - when the return is created in OmniReturns
Return Management Process - when the return status is updated in the Management report (manual)
In Transit - First mile carrier scan
Shopify store domain - add in all the shopify stores comma-separated. This will be something such as [retailername].myshopify.com
5. Click "ADVANCED SETTINGS"
On Advance Settings page, the user can manage:
Set Product Exclusion tags
Add/Update Shopify Private App integration
Manage Return Reasons
Return Rules
API Logs
1. Product Exclusion Tags
This must be set up before you add the Shopify store as the exclusion tags are set when orders are imported to our database.
Click on "Product Exclusion Tags" button on Shopify Private App Integrations listing to add exclusion tags
2. Add tags separated by a comma (e.g. “outlet,sale,discount-20”) and submit the form.
3. Any products with these tags will show as non-returnable in the customer portal
2. Add Shopify Integration
If the retailer would like different return triggers, return rules etc per shopify store. Each store should be added as it’s own integration (from the main integration page). Otherwise all stores can be added under the same shopify integration
Go back to the ‘Shopify Private App Integration’ page and click on ‘Add new integration’
Complete the form
Shop Name - retailer name and shopify store location e.g. Retailer All Locations
The below fields should be supplied from the retailer on the shopify integration formPrivate App Key
Private Shared Secret
Private App Password
Shop Domain
This MUST to be in the format e.g. hellomollyfashion-usa.myshopify.comWebhook version - if unsure, select the latest version
Tick “Import old store orders” - the date will auto select to the last 31 days as Shopify will not allow us to import orders beyond this.
Click SUBMIT
If there are any errors, check the Private App Key, Private Shared Secret, Private App Password to confirm these are entered in the correct field as the retailer may have put them in the wrong field.
3. Return Reasons
These are used when using Shopify Return Rules. If the customer choses the return action in the return portal, this is not needed.
Below are the default Return Reasons. You can select and submit the return reasons from default return reason list. The selected return reasons will be used to create the automated return rules to action refunds and/or store credits.
4. Returns Rules
To set up automated return rules, please see documentation Shopify Return Rules
5. API Logs
Use this to check on the status of refunds and store credits being issued to Shopify