README.md

Shopify Auto-Tag Customers

An example of a private Shopify app to auto-tagging customers based on order information.

Requirements

• Node.js 5.x.x or newer
• ngrok
• Chrome
• Postman Extension
• Shopify store

Setup

Environment

1. Create a private app in your Shopify store
2. Git clone shopify-auto-tag-customers-example
3. Run npm install
4. Setup .env at the root of shopify-auto-tag-customers

API_KEY=xxxxxxxxxxxxxxxxxxx
PASSWORD=xxxxxxxxxxxxxxxxxxx
SHARED_SECRET=xxxxxxxxxxxxxxxxxxx
STORE=xxxxxxxxxxxxxxxxxxx

Webhooks

This step will need to be repeated each time you renew your ngrok tunnel.

If this is your first time running this, skip to step 4.

1. Get your private app URL with your authentication.

2. With Postman, GET all your webhooks. (https://apikey:password@hostname/admin/webhooks.json)

3. Now, if one these webhooks is one that you have already created for this app, you will PUT the new address from ngrok.

{
  "webhook": {
    "id": 1111111111,
    "address": "http://64ec84c4.ngrok.io/order_create"
  }
}

4. If you're subscribing to a new hook, we will POST with the new address from ngrok.

{
  "webhook": {
    "address": "http://64ec84c4.ngrok.io/order_create",
    "topic": "orders/fulfilled",
    "format": "json"
  }
}

Usage

1. Run npm start to get the local server up. (http://localhost:8000/)
2. Run npm run tunnel to get ngrok tunnelling your localhost to the outside world.
3. Setup a webhook on your Shopify store to point to your ngrok url.