Shopify Custom App

Overview

A custom app is an app that you or a developer builds exclusively for your Shopify store (unlike a public app, which is built to be used by many stores). You can use a custom app to connect WinMan to your Shopify admin and access your store’s data directly using Shopify’s APIs.

If you want a collaborator or staff account to create, edit, or delete custom apps, then you can give them the Develop apps permission. The collaborator or staff account must also have the relevant permissions to set certain API scopes.

Activate custom app development from the Shopify admin

Before you can create a custom app for your store, you need to activate custom app development. You need to be the store owner or a staff member with the Enable app development permission to activate custom app development.

Steps:

1. From your Shopify admin, click Settings > Apps and sales channels.
2. Click Develop apps.
3. Click Allow custom app development.
4. Read the warning and information provided, and then click Allow custom app development.

Create and install a custom app

After you’ve activated custom app development, you can create and install a custom app in your Shopify admin. You need to set API scopes to determine which parts of your store the custom app can access. After the app is installed, you’ll receive access tokens that the app uses to access information from your store using Shopify’s APIs.

The store owner, and collaborators and staff members with the relevant permissions, can create and install custom apps.

Create the app

1. From your Shopify admin, click Settings > Apps and sales channels.
2. Click Develop apps.
3. Click Create a custom app.
4. In the modal window, enter the App name and select an App developer. The app developer can be the store owner, or any staff or collaborator account with the Develop apps permission.
5. Click Create app.

Select API scopes

After you create a custom app, you can assign API scopes to it. A custom app can have Admin API scopes, Storefront API scopes, or both, depending on the requirements of the app. You need to select at least one scope before you install the app.

Steps:

1. Click Select scopes.
2. In the Admin API access scopes section, select the following API scopes to assign to the app.

write_assigned_fulfillment_orders
read_assigned_fulfillment_orders
write_customers
read_customers
write_discounts
read_discounts
write_draft_orders
read_draft_orders
write_fulfillments
read_fulfillments
write_inventory
read_inventory
write_locations
read_locations
write_metaobject_definitions
read_metaobject_definitions
write_order_edits
read_order_edits
write_orders
read_orders
write_price_rules
read_price_rules
write_product_listings
read_product_listings
write_products
read_products
write_shipping
read_shipping
read_shopify_payments_payouts
write_metaobjects
read_metaobjects

3. In the Storefront API access scopes section, no API scopes are required.
4. Click Save.

Install the app and get the API access tokens

After you’ve set API scopes for your app, you can install the app. You’ll get your API access token for the Admin API after you install.

Caution

The Admin API access token is displayed one time only, because the token provides API access to sensitive store data. After revealing the access token, write down or record the token somewhere secure so that you can refer to it again.

Treat the token like a password. Share the access token only with those that you trust.

You will need to enter the access token value in the configuration of your Shopify Commerce Channel.

Steps:

1. Click Install app.
2. In the modal window, click Install app.
3. Get the access token:

3. Go to the Admin API access token section and click Reveal token once. After revealing the full access token the first time this page is accessed, this page displays only the last 4 digits of the access token for reference on subsequent visits.

Uninstall a custom app

When you uninstall a custom app, your access tokens are revoked, any webhooks and fulfillment services registered under the app are removed, and your app can’t access store data. If you re-install the app, then you’ll get new access tokens.

1. From your Shopify admin, click Settings > Apps and sales channels.
2. Click Develop apps.
3. Click the name of the app that you want to uninstall.
4. Click Uninstall app.

Delete a custom app

When you delete a custom app, it can’t be recovered. If you want to temporarily deactivate an app on your store without deleting it, then uninstall the app instead.

1. From your Shopify admin, click Settings > Apps and sales channels.
2. Click Develop apps.
3. Click App settings.
4. Click Delete app.