Setup and Reference

Syncing Gift Vouchers to Shopify

How to sync Gift Vouchers with Shopify Plus.

Overview

Cin7 can update Gift Vouchers from the Cin7 POS to Shopify Plus and vice versa, allowing your customers to buy and redeem Gift Vouchers both in-store and online.

There are a few things to be aware of:

• Due to Shopify restrictions, Gift Voucher sync can only work with Shopify Plus accounts.
• In order to set up Gift Voucher syncing, you must create a Private App key, see below.
• Your gift voucher codes must have more than 8 digits to comply with Shopify's rules. Gift Vouchers with codes with less than 8 characters will not be synced to Shopify.

Setting up Gift Voucher Syncing

Before setup you will need to make a request for the Shopify Plus team to enable the Gift Card Adjustment endpoint for Private Apps. This setting does not appear by default but can be turned on by Shopify to allow modifying the balance of Gift Card values. The Shopify Plus team will be able to action this request.

Once this is done, you can then generate a Private App Key in Shopify.

1. From your Shopify admin, go to Apps.
2. Select Manage private apps (towards the bottom of the page).
3. Select Create a new private app.
4. In the App details section, enter a name for your private app (e.g., Cin7 Gift Vouchers) and a contact email address.
   Shopify uses the email address to contact the developer if there is an issue with the private app, such as when an API change might break it.
5. In the Admin API section, set all fields to No Access except for Gift Cards and Gift Card Adjustments which should be set to Read and Write. Gift Cards can be found by clicking Review disabled Admin API permissions.
6. Select Save and then copy the API Key and Password as you'll need these later.

See the Private Apps Help article for additional information

Next, set up Gift Voucher syncing in Cin7. By default, voucher syncing is turned off. To set up voucher sync:

1. While logged in as an Administrator, from the left navigation, select Integrations, then Shopify.
2. Selecting Settings, top right.
3. In the Additional Settings section, enter Private App Key and Password that you created in the step above.
4. Next, make sure the Gift Vouchers section is checked.
5. From within the Gift Vouchers menu set Enable Voucher Sync to "Yes".
6. Optionally, check Auto Upload Vouchers to ensure new gift vouchers are sent to Shopify automatically. 
7. Select Save Settings.

To complete the setup, you will need to enable Gift Voucher syncing at the POS.

1. Go to Cin7 Settings and select POS Settings.
2. In the e-Commerce Voucher Sync section, make sure Enable Voucher Sync is "On".
3. Make sure the correct Shopify store is select.
4. Select Save.

Now you're good to go!

Syncing Vouchers

On your Shopify dashboard, you will see the Gift Vouchers tile which displays a list of your latest vouchers and a list of vouchers in Cin7 which have not been synced to Shopify.

Selecting Upload New Vouchers will create the gift cards in Shopify Plus. Selecting Download Vouchers will download all Shopify's vouchers into Cin7's gift voucher database.

When you fully redeem a Gift Voucher via Cin7's POS, the gift card in Shopify Plus will be marked as redeemed in Shopify automatically. If you partially redeem a Gift Voucher via Cin7's POS, the corresponding voucher will be reduced by the correct amount.

If a Gift Voucher is redeemed from your Shopify store, at the time of downloading the order to Cin7 the corresponding gift voucher will be marked as redeemed.

If the full value of the Gift Voucher is not redeemed, the original voucher will be marked as redeemed and a new Gift Voucher (with the same reference no.) with the remaining balance will be automatically generated in Cin7 and uploaded to Shopify Plus.