01. Introduction
Welcome to the VoucherBoy family!
Here you can find written guides and videos on how to use the VoucherBoy app for Shopify.
If you haven't downloaded our app, what are you waiting for? You can get it here
02. Exporting bulk data
VoucherBoy offers 2 main types of bulk export:
Customers - Target a segment of customers and return every discount method each customer in the segment has used.
Discount - Target a single discount method and return every customer that has used the discount method at least once.
Each bulk export job generates a CSV file and gets sent to en email of your choice. There is no limit to how many jobs you can run.
To run an export, please follow these steps:
* Navigate to VoucherBoy (Apps / VoucherBoy)
* Click on ‘Export’ from the navigation on the left (or ‘Start’ from the export tile on the app homepage)
* Choose either Customer or Discount export type
* Select the item you would like to target
* Confirm email address the file should be sent to
* Click either ‘Export discounts’ or ‘Export customers’ depending on the export type
03. Querying indiviudal customers
VoucherBoy lets you query a single customer in the admin. It’s really easy to use, and provides a quick and easy way to see an individuals used discount methods.
To run a query, follow these steps:
* Navigate to ‘Customers’ from the Shopify admin
* Search / find the customer you want to query, then click on them to go their admin page in the admin
* Click on ‘More actions’ near the top right of the customers admin page
* Click ‘VoucherBoy - View discounts used’
This will open up a modal, then group and display all of the discount methods the selected customer has used.
04. Using the explorer tool
VoucherBoy includes a handy tool you can use to view discount usage all in one collated place. Simply find the discount you are looking for and view all the attached orders on screen!
To use the explorer, follow these steps:
* Navigate to VoucherBoy (Apps / VoucherBoy)
* Click on ‘Explore’ from the navigation on the left (or ‘Start’ from the explore tile on the app homepage)
* Find or search for the discount code you want to query
* Click ‘Associated Orders’
05. Using the API [Developer recommended]
Important
To use the API, you must first obtain your API key through the app.
Once you have installed and subscribed, navigate to “API”, then click the button that says “Reveal” in the API Settings box.
As well as our already awesome admin features, we offer an easy to use API to easily retrieve customers discounts data. You will be able to access the data provided by VoucherBoy from outside the Shopify Admin.
To use the API, you can make a requests to one of our endpoints, and provide your query and API key. If the credentials match, we will send back a JSON payload matching the type you request. We recommend only using this if you have at least a basic understanding of how APIs work.
View full API Docs & PlaygroundCritical!
Please ensure you keep your API key secure and don’t share it with anyone else. It should only be used in a server environment and not in a frontend / public environment.
If you haven't yet obtained your API key, please refer to the top of this guide.
You can use any language of your choice, but heres an example request to one of our customer endpoints in JavaScript:
const requestDiscountsByCustomer = await fetch('https://app.voucherboy.com/api/customer/12345678910', {
headers: {
'x-api-key': 'abcd1234-wxyz-1234-abc123xyz891'
}
})
const discountsByCustomerResponse = await requestDiscountsByCustomer.json();
console.log(discountsByCustomerResponse);
/*
{
"id": "12345678910",
"email": "hello@artisan.engineering",
"firstName": "Sid",
"lastName": "Newman",
"discountCodes": "WELCOME10, 1RJ0ATZQW0Z6, ABC",
"automaticDiscounts": "Auto 10% off for members",
"manualDiscounts": "£4 off"
}
*/06. Enjoy!
Thank you for using VoucherBoy!