https://github.com/reggi/node-shopify-sixworks

A series of webhook endpoints that allow a Shopify store and the fulfillment service Sixworks (James and James) to work with one-another.
https://github.com/reggi/node-shopify-sixworks

Last synced: about 1 month ago
JSON representation

A series of webhook endpoints that allow a Shopify store and the fulfillment service Sixworks (James and James) to work with one-another.

• Host: GitHub
• URL: https://github.com/reggi/node-shopify-sixworks
• Owner: reggi
• License: mit
• Created: 2015-05-13T20:29:27.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-14T17:19:23.000Z (almost 9 years ago)
• Last Synced: 2024-10-05T10:47:37.558Z (about 2 months ago)
• Language: JavaScript
• Size: 846 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Node Shopify Sixworks

This app does two things:

* listens to Shopify for created orders and create them to Sixworks

* listens to Sixworks for fulfilled orders and fulfill them them in Shopify

## Summary

This app bridges the connection between Shopify and Sixworks.

Here's the flow:

* When the application server runs it will ensure that a webhook connection with the Shopify store is enabled.

* The server waits.

* When an order is created in the Shopify store a webhook is sent to the endpoint `/order_created`

* The middleware file `order_created.js` will then do the following:

  * Basic body validation

  * Ensure this order hasn't already been processed

  * Insert the order

  * Validate the request headers

  * Ensure it's an actual order in Shopify (not trying to invent a new order)

  * Look it it's a order that needs to be fulfilled by Sixworks

  * Make the request to create order in Sixworks

  * Save the response from creating the order in Sixworks

* When an order is fulfilled by Sixworks a webhook is sent to the endpoint `/order_fulfilled`

* The middleware file `order_fulfilled.js` will then do the following:

  * Basic body validation

  * Fulfill the order in Shopify

  * Store the Shopify response from fulfilling the order

## Environment Variables

```bash

MONGOHQ_URL={{ value }}

SHOPIFY_API_KEY={{ value }}

SHOPIFY_PASSWORD={{ value }}

SHOPIFY_SHARED_SECRET={{ value }}

SHOPIFY_HOST_NAME={{ value }}

SHOPIFY_DEV_API_KEY={{ value }}

SHOPIFY_DEV_PASSWORD={{ value }}

SHOPIFY_DEV_SHARED_SECRET={{ value }}

SHOPIFY_DEV_HOST_NAME={{ value }}

SIXWORKS_URL={{ value }}

SIXWORKS_KEY={{ value }}

SIXWORKS_WEBHOOK_URL={{ value }}

ORDER_EMAIL_LOCK={{ value }}

NODE_ENV={{ value }}

```

## Accompanying Modules

These two modules were originally included in this repo, I moved them out into their own github projects so that I can remove `node_modules` from this repo and properly install all the node modules.

The first is the simple node node sixworks api.

* https://github.com/reggi/node-sixworks-api

The second is a primative version of the node shopify api. There's a specific branch `for-node-shopify-sixworks` that is specifically the version I pulled from this source. This isn't on NPM and needs to be installed with the following command (and it's in package.json).

```bash

npm install git+https://github.com/reggi/shopify-api.git#for-node-shopify-sixworks --save

```

* https://github.com/reggi/shopify-api/tree/for-node-shopify-sixworks

## Building from scratch

> Note: Ensure you have the environment variables set in a `.env` file.

```bash

git clone [email protected]:reggi/node-shopify-sixworks.git

cd node-shopify-sixworks

npm install

npm run local

heroku create node-shopify-sixworks

heroku config:push ## assuming you have .env setup

git push heroku master

heroku logs --tail

```

## Query The Last 100 Orders

Last 100 orders to enter the database that were sent to sixworks.

```javascript

find({"created.sixworks_response":{"$ne":false}}).sort({"created.date":-1}).limit(100)

```