Shopify Admin API

Shopify Admin API for Node.js is a promise-driven NodeJS library built to help developers easily authenticate and make calls against the Shopify API. It is forked from the deprecated Shopify-Prime library.

Shopify Admin API is complete with full TypeScript definitions for all classes, interfaces and functions, and provides many quality of life improvements over most other Node Shopify libs. Tired of using undocumented libs that haven't been updated in ages, expect you to know all of the URL paths, and are little more than a basic wrapper over Node's http library? Give Shopify Admin API a try!

Installation

Shopify Admin API can be installed from NPM:

npm install shopify-admin-api --save

After installation, import Shopify Admin API via Node's require or ES6 import syntax:

//via require
const Shopify = require("shopify-admin-api");

//via ES6
import * as Shopify from "shopify-admin-api";

Tests

To run the tests on your locale machine you need a Shopify test shop in which you have created a private app, then you have to copy the credentials of the private app in the .env file in this project root directory. You can use the .env-example as a template:

cp .env-example .env
editor-of-your-choice .env

Now the test can be started:

yarn run build
yarn run test

Typescript declarations

Using TypeScript? The TypeScript compiler will automatically pull in Shopify Admin API definitions for you when you install Shopify Admin API, as long as you're using TypeScript 2+. Interfaces and extra types are available under the Interfaces, Enums and Options exports from the main "shopify-admin-api" module.

import { Shops } from "shopify-admin-api";

// Typescript interfaces — not real JS objects:
import { Interfaces, Enums, Options } from "shopify-admin-api";

const shop: InterfacesShop = await new Shops(shopDomain, shopAccessToken).get(shopId);

Finally, because Shopify Admin API uses async/await and promises, you'll need to set your tsconfig.json's target to "es6". While not strictly necessary, Typescript won't know about the Promise type and will default all services' return types to any if you don't set your target to es6.

Async/await and promises

All Shopify Admin API functions are implemented as async/awaitable promises. You'll need Node.js v4 and above to use Shopify Admin API, as Node v3 and below don't support the generators needed for async/await.

Because async/await implements a promise-like interface in ES6, you can use the functions in this library in two different ways:

With async/await:

//1. async/await
const shop = await shops.get();

//Do something with the shop

With promises:

const shop = shops.get().then((shop) => {
    //Do something with the shop.
});

Both methods are supported and the results won't differ. The only difference is an awaited method will throw an error if the method fails, where a promise would just fail silently unless you use .catch.

For the sake of being concise, all examples in this doc will use async/await.

A work-in-progress

This library is still pretty new. It currently suppports the following Shopify APIs:

• OAuth authentication.
• Application charges (in-app purchases)
• Recurring application charges (subscriptions)
• Usage charges
• Shops
• Webhooks
• Script Tags
• Orders
• Application Credits
• Blogs
• Articles

More functionality will be added each week until it reachs full parity with Shopify's REST API.

Using Shopify Admin API with a public Shopify app

Note: All instances of shopAccessToken in the examples below do not refer to your Shopify API key. An access token is the token returned after authenticating and authorizing a Shopify app installation with a real Shopify store.

All instances of shopDomain refer to your users' *.myshopify.com URL (although their custom domain should work too).

import {Charges} from "shopify-admin-api";

const chargeService = new Charges(shopDomain, shopAccessToken);

Using Shopify Admin API with a private Shopify app

Shopify Admin API should work out of the box with your private Shopify application, all you need to do is replace the shopAccessToken with your private app's password when initializing a service:

import {Orders} from "shopify-admin-api";

const orderService = new Orders(shopDomain, privateAppPassword)

If you just need an access token for a private Shopify app, or for running the tests in this library, refer to the Tests section above.

Authorization and authentication

Ensure a given URL is a valid Shopify URL

This is a convenience method that validates whether a given URL is a valid Shopify shop. It's great for ensuring you don't redirect a user to an incorrect URL when you need them to authorize your app installation, and is ideally used in conjuction with .buildAuthorizationUrl.

Shopify Admin API will call the given URL and check for an X-ShopId header in the response. That header is present on all Shopify shops and its existence signals that the URL is indeed a Shopify URL.

Note, however, that this feature is undocumented by Shopify and may break at any time. Use at your own discretion.

import { Auth } from "shopify-admin-api";

const urlFromUser = "https://example.myshopify.com";
const isValidUrl = await Auth.isValidMyShopifyDomain(urlFromUser).

Build an authorization URL

Redirect your users to this authorization URL, where they'll be prompted to install your app to their Shopify store.

import { Auth } from "shopify-admin-api";

//This is the user's store URL.
const usersShopifyUrl = "https://example.myshopify.com";

//An optional URL to redirect the user to after they've confirmed app installation.
//If you don't specify a redirect url, Shopify will redirect to your app's default URL.
const redirectUrl = "https://example.com/my/redirect/url";

//An array of the Shopify access scopes your application needs to run.
const scopes = ["read_orders", "write_orders"];

//Build the URL and send your user to it where they'll be prompted to install your app.
const authUrl = await Auth.buildAuthorizationUrl(scopes, usersShopifyUrl, yourShopifyApiKey, redirectUrl);

Authorize an installation and generate an access token

Once you've sent a user to the authorization URL and they've confirmed your app installation, they'll be redirected back to your application at either the default app URL, or the redirect URL you passed in when building the authorization URL.

The access token you receive after authorizing should be stored in your database. You'll need it to access the shop's resources (e.g. orders, customers, fulfillments, etc.)

import { Auth } from "shopify-admin-api";

// The querystring will have several parameters you need for authorization.
// Refer to your server framework docs for details on getting a request querystring.
const code = request.QueryString["code"];
const shopUrl = request.QueryString["shop"];

const accessToken = await Auth.authorize(code, shopUrl, shopifyApiKey, shopifySecretKey)

Determine if a request is authentic

Any (non-webhook, non-proxy-page) request coming from Shopify will have a querystring paramater called 'hmac' that you can use to verify that the request is authentic. This hmac value is a hash of all querystring parameters and your app's secret key.

Pass the entire querystring to .isAuthenticRequest to verify the request.

import { Auth } from "shopify-admin-api";

const qs = request.QueryString;
const isAuthentic = await Auth.isAuthenticRequest(qs, shopifySecretKey);

if (isAuthentic) {
    //Request is authentic.
} else {
    //Request is not authentic and should not be acted on.
}

Determine if a proxy page request is authentic

Nearly identical to authenticating normal requests, a proxy page request only differs in the way the querystring is formatted to calculate the hmac signature. All proxy page requests coming from Shopify will have a querystring parameter named signature that you can use to verify the request. This signature is a hash of all querystring parameters and your app's secret key.

import { Auth } from "shopify-admin-api";

const qs = request.QueryString;
const isAuthentic = await Auth.isAuthenticProxyRequest(qs, shopifySecretKey);

if (isAuthentic) {
    //Request is authentic.
} else {
    //Request is not authentic and should not be acted on.
}

Determine if a webhook request is authentic

Any webhook request coming from Shopify will have a header called 'X-Shopify-Hmac-SHA256' that you can use to verify that the webhook is authentic. The header is a hash of the entire request body and your app's secret key.

Pass that header and the request body string to .isAuthenticWebhook to verify the request.

import { Auth } from "shopify-admin-api";

const hmacHeader = request.QueryString["X-Shopify-Hmac-SHA256"];
const body = request.body.toString();
const isAuthentic = await Auth.isAuthenticWebhook(hmacHeader, body, shopifySecretKey);

if (isAuthentic) {
    //Webhook is authentic.
} else {
    //Webhook is not authentic and should not be acted on.
}

You can also pass in the request body as a string, rather than using the input stream. However, the request body string needs to be identical to the way it was sent from Shopify. If it has been modified, the verification will fail.

Recurring Application Charges (monthly subscriptions)

The Shopify billing API lets you create a recurring charge on a shop owner's account, letting them pay you on a monthly basis for using your application.

Create a recurring charge

import { RecurringCharges } from "shopify-admin-api";

const service = new RecurringCharges(shopDomain, shopAccessToken);
let charge = {
    Name = "Lorem Ipsum Plan",
    Price = 12.34,
    Test = true,   //Marks this charge as a test, meaning it won't charge the shop owner.
    TrialDays = 21 //Don't charge the user for 21 days
}

charge = await service.create(charge);

Retrieve a recurring charge

import { RecurringCharges } from "shopify-admin-api";

const service = new RecurringCharges(shopDomain, shopAccessToken);
const charge = await service.get(chargeId);

Listing recurring charges

import { RecurringCharges } from "shopify-admin-api";

const service = new RecurringCharges(shopDomain, shopAccessToken);
const list = await service.list();

Activating a charge

Creating a charge does not actually charge the shop owner or even start their free trial. You need to send them to the charge's confirmation_url, have them accept the charge, then activate it.

import { RecurringCharges } from "shopify-admin-api";

const service = new RecurringCharges(shopDomain, shopAccessToken);

await service.activate(chargeId);

Deleting a charge

Charges cannot be deleted unless they've been activated. Shopify automatically deletes pending charges after 48 hours pass without activation.

import { RecurringCharges } from "shopify-admin-api";

const service = new RecurringCharges(shopDomain, shopAccessToken);

await service.delete(chargeId);

One-time application charges

Just like with the above recurring charges, the Shopify billing API lets you create a one-time application charge on the shop owner's account. One-time charges cannot be deleted.

Create a one-time charge

import { Charges } from "shopify-admin-api";

const service = new Charges(shopDomain, shopAccessToken);
let charge = {
    Name = "Lorem Ipsum Charge",
    Price = 12.34,
    Test = true, //Marks this charge as a test, meaning it won't charge the shop owner.
}

charge = await service.create(charge);

Retrieve a one-time charge

import { Charges } from "shopify-admin-api";

const service = new Charges(shopDomain, shopAccessToken);
const charge = await service.get(chargeId);

Listing one-time charges

import { Charges } from "shopify-admin-api";

const service = new Charges(shopDomain, shopAccessToken);
const list = service.list();

Activating a charge

Just like recurring charges, creating a one-time charge does not actually charge the shop owner. You need to send them to the charge's ConfirmationUrl, have them accept the charge, then activate it.

import { Charges } from "shopify-admin-api";

const service = new Charges(shopDomain, shopAccessToken);

await service.activate(chargeId);

Usage charges

Shopify's Usage Charges let you set a capped amount on a recurring application charge, and only charge for usage. For example, you can create a charge that's capped at $100.00 per month, and then charge e.g. $1.00 for every 1000 emails your user sends using your app.

To create a usage charge, you first need to create a recurring charge with a capped_amount value and a terms string. Your customers will see the terms when activating the recurring charge, so set it to something they can read like "$1.00 per 1000 emails".

Creating a usage charge

import { UsageCharges } from "shopify-admin-api";

const service = new UsageCharges(shopDomain, shopAccessToken);
const charge = await service.create(recurringChargeId, {description: "Used 1000 emails", price: 1.00});

Getting a usage charge

import { UsageCharges } from "shopify-admin-api";

const service = new UsageCharges(shopDomain, shopAccessToken);
const charge = await service.get(recurringChargeId, usageChargeId);

Listing usage charges

import { UsageCharges } from "shopify-admin-api";

const service = new UsageCharges(shopDomain, shopAccessToken);
const list = await service.list(recurringChargeId);

Shops

Retrieving shop information

import { Shops } from "shopify-admin-api";

const service = new Shops(shopDomain, shopAccessToken);
const shop = await service.get();

Uninstalling your app

In cases where user intervention is not required, you can send a request to a Shopify shop to force it to uninstall your application. After sending this request, the shop access token will be immediately revoked and invalidated.

Uninstalling an application is an irreversible operation. Be entirely sure that you no longer need to make API calls for the shop in which the application has been installed.

Uninstalling an application also performs various cleanup tasks within Shopify. Registered Webhooks, ScriptTags and App Links will be destroyed as part of this operation. Also if an application is uninstalled during key rotation, both the old and new Access Tokens will be rendered useless.

import { Shops } from "shopify-admin-api";

const service = new Shops(shopDomain, shopAccessToken);

await shop.forceUninstallApp();

Webhooks

Creating a webhook

import { Webhooks } from "shopify-admin-api";

const service = new Webhooks(shopDomain, shopAccessToken);
let webhook = {
    address = "https://my.webhook.url.com/path",
    topic = "themes/publish",
};

webhook = await service.create(webhook);

Retrieving a webhook

import { Webhooks } from "shopify-admin-api";

const service = new Webhooks(shopDomain, shopAccessToken);
const webhook = await service.get(webhookId);

Updating a webhook

import { Webhooks } from "shopify-admin-api";

const service = new Webhooks(shopDomain, shopAccessToken);
const webhook = await service.update(webhookId, {
    address: "https://my.webhook.url.com/new/path"
});

Deleting a webhook

import { Webhooks } from "shopify-admin-api";

const service = new Webhooks(shopDomain, shopAccessToken);

await service.delete(webhookId);

Counting webhooks

import { Webhooks } from "shopify-admin-api";

const service = new Webhooks(shopDomain, shopAccessToken);
const count = await service.count();

Listing webhooks

import { Webhooks } from "shopify-admin-api";

const service = new Webhooks(shopDomain, shopAccessToken);
const webhooks = await service.list();

Script Tags

Script tags let you add remote javascript tags that are loaded into the pages of a shop's storefront, letting you dynamically change the functionality of their shop without manually editing their store's template.

Creating a script tag

import { ScriptTags } from "shopify-admin-api";

const service = new ScriptTags(shopDomain, shopAccessToken);
let tag = {
    event: "onload",
    src: "https://example.com/my-javascript-file.js",
    display_scope: "all"
}

tag = await service.create(tag);

Retrieving a script tag

import { ScriptTags } from "shopify-admin-api";

const service = new ScriptTags(shopDomain, shopAccessToken);
const tag = await service.get(tagId);

Updating a script tag

import { ScriptTags } from "shopify-admin-api";

const service = new ScriptTags(shopDomain, shopAccessToken);
let tag = await service.get(tagId);

tag = await service.update(tag.id, {src: "https://example.com/my-new-javascript-file.js"});

Deleting a script tag

import { ScriptTags } from "shopify-admin-api";

const service = new ScriptTags(shopDomain, shopAccessToken);

await service.delete(tagId);

Counting script tags

import { ScriptTags } from "shopify-admin-api";

const service = new ScriptTags(shopDomain, shopAccessToken);
let count = await service.count();

//Optionally filter the count to only those tags with a specific Src
count = await service.count({src: "https://example.com/my-filtered-url.js"});

Listing script tags

import {ScriptTags, ScriptTag} from "shopify-admin-api";

const service = new ScriptTags(shopDomain, shopAccessToken);
let tags = await service.list();

//Optionally filter the list to only those tags with a specific Src
tags = await service.list({src: "https://example.com/my-filtered-url.js"});

Customers

The Customer resource stores information about a shop's customers, such as their contact details, their order history, and whether they've agreed to receive email marketing.

Listing Customers

import { Customers } from "shopify-admin-api";
const service = new Customers(shopDomain, shopAccessToken);
let customers = await service.list();

// Optionally, filter the list for new customers
let customers = await service.list({ limit: 10, since_id: customerId });

Searching Customers

import { Customers } from "shopify-admin-api";
const service = new Customers(shopDomain, shopAccessToken);

let search = await service.search({query: 'Bob country:United States'});

Getting count of Customers

import { Customers } from "shopify-admin-api";
const service = new Customers(shopDomain, shopAccessToken);

let count = await service.count();

Creating a Customer

import { Customers } from "shopify-admin-api";
const service = new Customers(shopDomain, shopAccessToken);

let customer = await service.create({
  email: "customer@myshopify.com",
  first_name: "Jane",
  last_name: "Doe"
});

Updating a Customer

import { Customers } from "shopify-admin-api";
const service = new Customers(shopDomain, shopAccessToken);

let customer = await service.update({
  email: "newemail@myshopify.com"
});

Deleting a Customer

import { Customers } from "shopify-admin-api";
const service = new Customers(shopDomain, shopAccessToken);

let customer = await service.delete(123456789);

Generating activation URL

import { Customers } from "shopify-admin-api";
const service = new Customers(shopDomain, shopAccessToken);

let url = await service.createActivationUrl(123456789);
// => https://domain.myshopify.comcom/account/activate/XXXXXX/XXXXXXXXXXXXX

Inviting a Customer

import { Customers } from "shopify-admin-api";
const service = new Customers(shopDomain, shopAccessToken);
const invite = await service.invite();

// Optionally, send a custom invite
const invite = await service.invite({
  to: "alternateemail@gmail.com",
  from: "fromemail@myshopify.com",
  subject: "Welcome!",
  custom_message: "My custom message"
});

Orders

Creating an Order

import { Orders } from "shopify-admin-api";

const service = new Orders(shopDomain, shopAccessToken);
const order = await service.create({
    billing_address: {
        address1: "123 4th Street",
        city: "Minneapolis",
        province: "Minnesota",
        province_code: "MN",
        zip: "55401",
        phone: "555-555-5555",
        first_name: "John",
        last_name: "Doe",
        company: "Tomorrow Corporation",
        country: "United States",
        country_code: "US",
        default: true,
    },
    line_items: [
        {
            name: "Test Line Item",
            title: "Test Line Item Title",
            quantity: 2,
            price: 5
        },
        {
            name: "Test Line Item 2",
            title: "Test Line Item Title 2",
            quantity: 2,
            price: 5
        }
    ],
    financial_status: "paid",
    total_price: 5.00,
    email: Date.now() + "@gmail.com",
    note: "Test note about the customer.",
});

Getting an Order

import { Orders } from "shopify-admin-api";

const service = new Orders(shopDomain, shopAccessToken);
const order = await service.get(id);

Updating an Order

import { Orders } from "shopify-admin-api";

const service = new Orders(shopDomain, shopAccessToken);
let order = await service.get(id);

order.note = "Updated note";
order = await service.update(id, order);

Listing Orders

import { Orders } from "shopify-admin-api";

const service = new Orders(shopDomain, shopAccessToken);
const orders = await service.list();

Counting Orders

import { Orders } from "shopify-admin-api";

const service = new Orders(shopDomain, shopAccessToken);
const orderCount = await service.count();

Deleting an Order

import { Orders } from "shopify-admin-api";

const service = new Orders(shopDomain, shopAccessToken);

await service.delete(id);

Closing an Order

import { Orders } from "shopify-admin-api";

const service = new Orders(shopDomain, shopAccessToken);
const order = await service.close(id);

Opening an Order

import { Orders } from "shopify-admin-api";

const service = new Orders(shopDomain, shopAccessToken);
const order = await service.open(id);

Canceling an Order

import { Orders } from "shopify-admin-api";

const service = new Orders(shopDomain, shopAccessToken);

await service.cancel(id, {
    reason: "customer"
});

Application Credits

Shopify's Application Credit API lets you offer credits for payments your app customers have made via the Application Charge, Recurring Application Charge, and Usage Charge APIs.

The total amount of all Application Credits created by an application must not exceed:

1. Total amount paid to the application by the shop owner in the last 30 days.
2. Total amount of pending receivables in the partner account associated with the application.

Additionally, Application Credits cannot be used by private applications.

Creating an Application Credit

import { ApplicationCredits } from "shopify-admin-api";

const service = new ApplicationCredits(shopDomain, shopAccessToken);
const credit = await service.create({
    description: "Refund for Foo",
    amount: 10.00
});

Getting an Application Credit

import { ApplicationCredits } from "shopify-admin-api";

const service = new ApplicationCredits(shopDomain, shopAccessToken);
const credit = await service.get(id);

Listing Application Credits

import { ApplicationCredits } from "shopify-admin-api";

const service = new ApplicationCredits(shopDomain, shopAccessToken);
const credits = await service.list();

Blogs

In addition to an online storefront, Shopify shops come with a built-in blogging engine, allowing a shop to have one or more blogs. This class is for interacting with blogs themselves, not blog posts.

Creating a Blog

import { Blogs } from "shopify-admin-api";

const service = new Blogs(shopDomain, shopAccessToken)
const blog = await service.create({
    title: "My new blog",
})

Getting a Blog

import { Blogs } from "shopify-admin-api";

const service = new Blogs(shopDomain, shopAccessToken)
const blog = await service.get(blogId);

Updating a Blog

import { Blogs } from "shopify-admin-api";

const service = new Blogs(shopDomain, shopAccessToken)
const blog = await service.update(blogId, {
    title: "My updated blog title"
})

Listing Blogs

import { Blogs } from "shopify-admin-api";

const service = new Blogs(shopDomain, shopAccessToken)
const blogs = await service.list();

Counting Blogs

import { Blogs } from "shopify-admin-api";

const service = new Blogs(shopDomain, shopAccessToken)
const count = await service.count();

Deleting a Blog

import { Blogs } from "shopify-admin-api";

const service = new Blogs(shopDomain, shopAccessToken)

await service.delete(blogId);

Articles

Articles are objects representing a blog post. Each article belongs to a Blog.

Creating an Article

import { Articles } from "shopify-admin-api";

const service = new Articles(shopDomain, shopAccessToken);
const article = await service.create(blogId, {
    title: "My new Article title",
    author: "John Smith",
    tags: "This Post, Has Been Tagged",
    body_html: "<h1>Hello world!</h1>",
    image: {
        attachment: "R0lGODlhAQABAIAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==\n"
    }
})

Getting an Article

import { Articles } from "shopify-admin-api";

const service = new Articles(shopDomain, shopAccessToken);
const article = await service.get(blogId, articleId);

Updating an Article

import { Articles } from "shopify-admin-api";

const service = new Articles(shopDomain, shopAccessToken);
const article = await service.update(blogId, articleId, {
    title: "My updated title"
})

Listing Articles

import { Articles } from "shopify-admin-api";

const service = new Articles(shopDomain, shopAccessToken);
const articles = await service.list(blogId);

Counting Articles

import { Articles } from "shopify-admin-api";

const service = new Articles(shopDomain, shopAccessToken);
const count = await service.count(blogId);

Deleting an Article

import { Articles } from "shopify-admin-api";

const service = new Articles(shopDomain, shopAccessToken);

await service.delete(blogId, articleId);

Listing all Article authors

import { Articles } from "shopify-admin-api";

const service = new Articles(shopDomain, shopAccessToken);
const authors = await service.listAuthors();

console.log(authors); // ['John Doe', 'Jane Doe']

Listing all Article tags

import { Articles } from "shopify-admin-api";

const service = new Articles(shopDomain, shopAccessToken);
const tags = await service.listTags();

console.log(tags); // ['Tag One', 'Tag Two']

Listing all Article tags for a blog

import { Articles } from "shopify-admin-api";

const service = new Articles(shopDomain, shopAccessToken);
const tags = await service.listTagsForBlog(blogId);

console.log(tags); // ['Tag One', 'Tag Two']