shopify-node-api

OAuth2 Module for Shopify API

Installation

Node.js:

npm install shopify-node-api

Setup

var shopifyAPI = require('shopify-node-api');

var Shopify = new shopifyAPI({
                shop: 'MYSHOP', // MYSHOP.myshopify.com
                shopify_api_key: '', // Your API key
                shopify_shared_secret: '', // Your Shared Secret
                shopify_scope: 'write_products',
                redirect_uri: 'http://localhost:3000/finish_auth'
            });
            

Usage

// Building the authentication url

var auth_url = Shopify.buildAuthURL();

// Assuming you are using the express framework 
// you can redirect the user automatically like so
res.redirect(auth_url);

Exchanging the temporary token for a permanent one

After the user visits the authenticaion url they will be redirected to the location you specified in the configuration redirect_url parameter.

Shopify will send along some query parameters including: code (your temporary token), signature, shop and timestamp. This module will verify the authenticity of the request from shopify as outlined here in the Shopify OAuth Docs

// Again assuming you are using the express framework

app.get('/finish_auth', function(req, res){

  var Shopify = new shopifyAPI(config), // You need to pass in your config here
    query_params = req.query;
    
  Shopify.exchange_temporary_token(query_params, function(data){
    // This will return successful if the request was authentic from Shopify
    // Otherwise an error with a message will be returned. 
    // The module will automatically update your config with the new access token
    // It is also available here as data['access_token']
  });

});

Making requests

This module supports GET, POST, PUT and DELETE rest verbs.

GET

Shopify.get('/admin/products.json', function(data){
    console.log(data); // Data contains product json information
});

POST

var post_data = {
  "product": {
    "title": "Burton Custom Freestlye 151",
    "body_html": "<strong>Good snowboard!</strong>",
    "vendor": "Burton",
    "product_type": "Snowboard",
    "variants": [
      {
        "option1": "First",
        "price": "10.00",
        "sku": 123
      },
      {
        "option1": "Second",
        "price": "20.00",
        "sku": "123"
      }
    ]
  }
}

Shopify.post('/admin/products/1234567.json', post_data, function(data){
  console.log(data);
});

PUT

var put_data = {
  "product": {
    "body_html": "<strong>Updated!</strong>"
  }
}

Shopify.put('/admin/products/1234567.json', put_data, function(data){
  console.log(data);
});

DELETE

Shopify.delete('/admin/products/1234567.json', function(data){
    console.log(data);
});