Please note that you'll need to be a Store Owner user to create the API on Step 2.

The Toggle set up (Steps 1-5)

Step 1: Add your site(s) on Toggle

The sites you'll be redeeming gift cards at need adding to Toggle. This step might already be done, but it's worth checking.

Log in to Toggle
On the sidebar click Settings > Site Settings
Add the site name, its address, and any number or reference for it
Click add
Repeat this step for however many sites you need to add

Step 2: Create an API on Toggle

If needed here's more info on how to create the API.

Log in to Toggle
On the sidebar click Settings > Integrations > Cunninghams
Click create new user
Copy the username and password onto a separate document and press create

(Please note only 'Store Owner' users can create an API - if you can't create the API please ask your accounts Store Owner to help you).

When you're creating the API, remember to copy and paste the username and password into a separate document on your computer because once you've saved it, you can't retrieve the password again.

Step 3: Send the API to your Cunninghams Account Manager

You'll need to send the API username and password you created on Step 2 along with the info below to your Cunninghams Account Manager.

We've made the below table that you can copy and paste into the email you'll send to Cunninghams, if that makes it easier. To ensure data is protected, we advise you send the below info in a password protected email.

API endpoint:	https://api.mytoggle.io/graphql
Username:	(add the username you create here)
Password:	(add the password you create here)
Merchant ref:	32
Standard in-store product ID:	(find this on Shop > In-Store gift)
Account ID:	(ask Toggle for this)

The API endpoint is always https://api.mytoggle.io/graphql and the merchant ref 32 - don't change this.

Please get in touch with success@usetoggle.com to get your account ID.

Step 4: Ask your Cunninghams Account Manager for the "site IDs" for your sites

Once you have the IDs from Cunninghams:

Log in to Toggle
On the sidebar click Settings > Integrations > Cunninghams
Paste in each ID to their respective site
Save

The site IDs allow the Cunninghams and Toggle system to know where a gift card was sold or redeemed at - this information will pull through to your Toggle reports. Without these, the integration won't work.

Step 5: Test the integration works

Once Cunninghams have configured the Toggle API on their side, it's good practice to test if Toggle gift cards work on your tills. We recommend issuing yourself a free of charge digital voucher that you can send to your email. Using the voucher number, key it or scan it into your tills and see if it recognises the voucher. Try redeeming some if it and reversing it.

Other people on your team may benefit from seeing how it works.

If an error is flagged on the till, get in touch with Toggle and Cunninghams so we can help troubleshoot it.