Skip to content
On this page

Custom App

Overview

A custom app allows a developer to add features to your Shopify admin, access your store's data directly using Shopify's APIs, and extend your online store to another platform using the Storefront API.

The steps below are normally performed by Order Protection after you have accepted their collaborator request.

Enable custom app development

Before a custom app can be created, custom app development must be enabled in Shopify. Only the store owner, or staff with Enable app development permission, can enable 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.

    Allow custom app development screen 1

  4. Read the warning and information provided, and then click Allow custom app development.

    Allow custom app development screen 2

Create the app

  1. From your Shopify admin, click Settings > Apps and sales channels.

  2. Click Develop apps.

    Develop apps button

  3. Click Create an app.

    Create an app button

  4. In the modal window, enter OrderProtection.com for the App name and select OrderProtection.com (admin@orderprotection.com) for the App developer.

    Create app button

  5. Click Create app.

Select API scopes

Now that you have created the custom app, you can assign API scopes to it.

  1. From the Overview tab, click Configure Admin API scopes.

  2. In the Admin API access scopes section, select the following API scopes:

    • Analytics
      • read_analytics
    • Assigned fulfillment orders
      • write_assigned_fulfillment_orders
      • read_assigned_fulfillment_orders
    • Customers
      • write_customers
      • read_customers
    • Discounts
      • write_discounts
      • read_discounts
    • Draft orders
      • write_draft_orders
      • read_draft_orders
    • Fulfillment services
      • write_fulfillments
      • read_fulfillments
    • GDPR data requests
      • read_gdpr_data_request
    • Merchant-managed fulfillment orders
      • write_merchant_managed_fulfillment_orders
      • read_merchant_managed_fulfillment_orders
    • Order editing
      • write_order_edits
      • read_order_edits
    • Orders
      • write_orders
      • read_orders
    • Products
      • write_products
      • read_products
    • Reports
      • write_reports
      • read_reports
  3. In the Webhook subscriptions section, select whichever version has (Latest) in the name.

    Admin API scopes

  4. Click Save.

Install the app and get the API access tokens

You are now ready to install the app. You'll get your API access tokens after you install. Depending on what API scopes you assigned to the app, you'll get an Admin API access token, a Storefront API access token, or both.

  1. Confirm the Admin API access scopes then click Install app.

    Install app button

  2. In the modal window, click Install.

    Install app confirmation

  3. In the Admin API access token section, click Reveal token once.

    Caution You can see the Admin API access token on this page only one time, because the token provides API access to sensitive store data. After revealing the access token, copy the token and paste it somewhere secure so that you can refer to it again. Treat the token like a password. After revealing the full access token once, this page displays only the last 4 digits of the access token for reference.

    Reveal token

  4. Copy values for Admin API access token, API key, and API secret key and send them to your account manager so they can finish onboarding your store.

    API values