@shopify/shopify-api

This library provides support for TypeScript/JavaScript Shopify apps to access the Shopify Admin API, by making it easier to perform the following actions:

• Creating online or offline access tokens for the Admin API via OAuth
• Making requests to the REST API
• Making requests to the GraphQL API
• Register/process webhooks

This library can be used in any application that has a Node.js backend, since it doesn't rely on any specific framework—you can include it alongside your preferred stack and only use the features that you need to build your app.

Requirements

To follow these usage guides, you will need to:

• have a basic understanding of Node.js
• have a Shopify Partner account and development store
• OR have a test store where you can create a private app
• have a private or custom app already set up in your test store or partner account
• use ngrok, in order to create a secure tunnel to your app running on your localhost
• add the ngrok URL and the appropriate redirect for your OAuth callback route to your app settings
• have yarn installed

Getting started

You can follow our getting started guide, which will provide instructions on how to create an app using plain Node.js code, or the Express framework. Both examples are written in Typescript.

• Getting started
  • Install dependencies
  • Set up base files
  • Set up environment
  • Set up Context
  • Running your app
• Performing OAuth
  • Add a route to start OAuth
  • Add your OAuth callback route
  • Fetching sessions
  • Detecting scope changes
• Make a REST API call
• Make a GraphQL API call
• Webhooks
  • Register a Webhook
  • Process a Webhook
• Known issues and caveats
  • Notes on session handling