Skip to main content

Getting started with Shopify

In this section, I will just cover all the most basic Shopify developments knowledge, it is best that you look up Shopify dev doc itself:

Shopify Introduction

info

It is compulsory that your store, partner account language is English. Change it in your Shopify account seting:

Shopify Admin Rest API

The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit Shopify migration guide.

Shopify GraphQL API 101

Shopify Protected Data - 2022-07 API version

If you encounter 403 error while calling API to endpoints regarding orders, customers that have customers personal info as email, firstName, lastName, phone, and address, then you may be missing the Shopify Protected Data request for your app. On your local and staging app, requesting for Shopify Protected Data is quite easy, you just need to fill out the form without submitting. On the contrary, with production app, you will need to ask for approval, which may takes a couple of days to approve.

Shopify Webhook 101

When your app needs information about specific events that have occurred on a shop, it can subscribe to Shopify webhook topics as a mechanism for receiving near-real-time data about these events. Shopify webhooks are useful for keeping your app in sync with Shopify data, or as a trigger to perform an additional action after that event has occurred. They are also a performant alternative to continuously polling for changes to a shop's data. This guide provides a quick primer on when to use APIs versus webhooks, as well as key terminology and behaviors that are specific to Shopify webhooks.

Examples of when your app might use webhooksAnchor link to section titled "Examples of when your app might use webhooks"

  • Sending notifications about changes in inventory levels to inventory management clients and pagers
  • Informing shipping companies about changes in orders, returns, or refunds
  • Removing customer data from a database for app uninstalls. However, cannot do anything else with Shopify API after the unstall because the access is revoked.
  • Integrating data about orders with accounting software
  • Updating a product's warranty price based on changes to the product's price

See Shopify official guide here.

Shopify Further Dive (Optional for now until week 5)

You should spend your time digesting Shopify development docs further more to better understand Shopify ecosystem: