This is a module for the MagicMirror².
For Shopify store owners!
Display your open order count on your MagicMirror. Set an urgency threshold so the text glows if orders are piling up.
Supports internationalization of "Orders" via translation json files.
This is a big involved, so here is a detailed tutorial:
https://help.shopify.com/en/manual/apps/app-types/custom-apps
You just need to make a personal dev app, name it whatever you want, add the scope read_orders
, and install it to get your Admin API Access Token
.
To use this module, add the following configuration block to the modules array in the config/config.js
file:
var config = {
modules: [
{
module: 'MMM-ShopifyOrders',
config: {
// See below for configurable options
updateInterval: 60000,
urgentLevel: 10,
shopify: {
accessToken: 'your secret developer app admin api access token',
storeUrl: 'https://your-dev-store.myshopify.com',
orderFilter: 'unfulfilled', // any, fulfilled, unfulfilled, etc
}
}
}
]
}
Option | Type | Default | Necessity | Description |
---|---|---|---|---|
updateInterval |
int (milliseconds) |
60000ms (1 minute) | Optional | How often to update the order count (by hitting the Shopify API). |
urgentLevel |
int (count) |
10 | Optional | If there are more orders than this, the count will glow with ugency. |
shopify:accessToken |
string |
Required | Shopify developer app Admin API Access Token. | |
shopify:storeUrl |
url |
Required | Your Shopify dev store url. The myshopify.com one. | |
shopify:orderFilter |
string |
'unfulfilled' | Optional | Which order statuses to count: any, unfulfilled, fulfilled |
This module was bootstrapped using https://github.com/roramirez/MagicMirror-Module-Template