Application Configuration in Shopify Portal for OAuth2 Account to use in Shopify

In this article

Snaps in the Shopify Snap Pack use the Shopify OAuth2 account to access the Shopify application. For the OAuth2 account to function without any issue, ensure to create and configure an application corresponding to the account as explained in the steps below. These steps also contain the information required to create/define a new OAuth2 account for using this Snap Pack.

A public app should interact with Shopify APIs on behalf of multiple stores. To authenticate with Shopify by using a public app, you need to generate the credentials from your Partner Dashboard and then use them to implement OAuth. Shopify uses OAuth 2.0’s authorization code grant flow to issue access tokens on behalf of users.

Create an app and access Shopify Portal

Prerequisite: You must configure a Shopify Partner’s account on Shopify portal.

  1. Log into the Shopify Portal.

  2. In the left navigation pane, click Apps and select Create app on the top-right of the page.

  3. Click Public app.

  4. Specify the following details to help identify your app in the Shopify Partner dashboard.:

    • App name: Specify a unique name for the app. For example, succulents.retailer@gmail.com

    • APP URL: Specify the URL for the app. For example, https://neesho.com

    • Allowed redirection URL(s): Specify at least one redirect URL for authentication before making your app public. You can change the Redirect URL any number of times.

  5. Click Create app on the top right-side of the page.
    The app is created and listed on the Apps page.

     

You can click App setup to view your App details.

Create Store

Prerequisite: You must have a Shopify Partner’s account on Shopify portal.

  1. Log into the Shopify Portal.

  2. In the left navigation pane, click Stores and click Add Store on the top-right of the page.

  3. Choose Development store as your store type.

  4. Specify the following details for your store.

    1. Store name: Specify a store name to help identify your store. For example, Dollar99

    2. Store URL: Specify a URL for your store. For example, Dollar99.myshopify.com

    3. Login: Enter a business email address to log in. For example, dollar99.store@gmail.com.

    4. Password: Specify the password you want to use to log in to the store.

    5. Confirm password: Confirm the password.

  5. Specify the Store address and Store purpose.

  6. Click Save to save the store details.

  7. Navigate to Apps, select any existing or recently created app.

  8. Click Select Store to select the recently created store.

You can manage your orders, products, and customers using the store login.

Locate/Define Information Required to Create your Shopify OAuth2 Account

Specify the values required to create a successful Snap account connection.

  1. Navigate to the Shopify Snap of your choice and set up the Shopify OAuth2 Account with the following details:

    • Store name

    • Client Id

    • Client Secret

    • Token Endpoint Configuration

    • Auth Endpoint configuration Scope(s)

      • Authentication parameter: scope

      • Authentication parameter valuewrite_draft_orders, read_draft_orders, read_order_edits

  2. Click Authorize
    You will be redirected to the login page of Shopify. If you provide any new scopes, then click on Install App.

    1. Log into Shopify and accept the permissions.
      The Access token and the Refresh Token will be generated.

    2. Select the Auto-refresh token checkbox and save the account.

Scopes and Permissions Required for Shopify API

Authenticated access scopes control access to resources in the REST Admin API and the Graph QL Admin API. Authenticated access is intended for interacting with a store on behalf of the merchant to perform actions such as creating products and managing discount codes. When users sign into Shopify app, they must subscribe to these scopes. 

API Name

Scope

API Name

Scope

Customer

read_customerswrite_customers,read_orderswrite_orders

Orders

read_orderswrite_orders

read_all_orders,read_shippingwrite_shipping,read_third_party_fulfillment_orderswrite_third_party_fulfillment_orders,read_order_editswrite_order_edits,read_merchant_managed_fulfillment_orderswrite_merchant_managed_fulfillment_orders

Fulfillment

read_orderswrite_orders

Transaction

read_orderswrite_orders, read_shopify_payments_payouts

 Inventory Level

read_inventory, write_inventory

 Inventory Item

read_inventory, write_inventory

Fulfillment Service

read_fulfillmentswrite_fulfillments

Fulfillment Order

read_assigned_fulfillment_orderswrite_assigned_fulfillment_orders

Gift Card

read_gift_cardswrite_gift_cards

User

read_userswrite_users

Checkouts

read_checkoutswrite_checkouts

Reports

read_reportswrite_reports

Payout

read_shopify_payments_payouts

Balance

read_shopify_payments_payouts

Product Listing

read_product_listings

Products

read_products, write_products,read_inventorywrite_inventory

See Admin API Access Scopes for more information.


See Also