Skip to main content
Ocular connects to Shopify and Shopify Plus stores via Custom App.

​
Custom App

Follow the instructions below to create a custom app in your Shopify account and get the credentials required for configuration.

Log in to Shopify

Log in to your Shopify account.

Open App settings

On the left-hand navigation menu, click Apps, and then select App settings.
Shopify00Shopify00

Shopify admin → Apps

Shopify01Shopify01

Apps → App settings

Click Develop apps

Shopify Develop Apps

Apps → Develop apps

Click Build apps in Dev Dashboard

Shopify1

App development → Build apps in Dev Dashboard

Click Create app

Shopify2

Dev Dashboard → Create app

Enter an App name e.g. ocular_v1

Shopify3

Create an app → App name

Click on ‘Select Scopes’ and check the roles as mentioned below:

In the allowed redirection URL add this: https://api.ocular.dev/oauth/callback/shopify
Shopify4

API access → Select scopes

Configure the following Admin API scopes in App → Configuration:
  • Admin API scopes
    • read_all_orders
    • read_analytics
    • read_app_proxy
    • read_apps
    • read_assigned_fulfillment_orders
    • read_audit_events
    • read_customer_events
    • read_cart_transforms
    • read_validations
    • read_cash_tracking
    • read_channels
    • read_checkout_and_accounts_configurations
    • read_checkout_branding_settings
    • read_checkouts
    • read_companies
    • read_custom_fulfillment_services
    • read_custom_pixels
    • read_customers
    • read_customer_data_erasure
    • read_customer_payment_methods
    • read_customer_merge
    • read_delivery_customizations
    • read_price_rules
    • read_discounts
    • read_discounts_allocator_functions
    • read_discovery
    • read_draft_orders
    • read_files
    • read_fulfillment_constraint_rules
    • read_fulfillments
    • read_gift_card_transactions
    • read_gift_cards
    • read_inventory
    • read_inventory_shipments
    • read_inventory_shipments_received_items
    • read_inventory_transfers
    • read_legal_policies
    • read_delivery_option_generators
    • read_locales
    • read_locations
    • read_marketing_integrated_campaigns
    • read_marketing_events
    • read_markets
    • read_markets_home
    • read_merchant_managed_fulfillment_orders
    • read_metaobject_definitions
    • read_metaobjects
    • read_online_store_navigation
    • read_online_store_pages
    • read_order_edits
    • read_orders
    • read_packing_slip_templates
    • read_payment_mandate
    • read_payment_terms
    • read_payment_customizations
    • read_privacy_settings
    • read_product_feeds
    • read_product_listings
    • read_products
    • read_publications
    • read_purchase_options
    • read_reports
    • read_resource_feedbacks
    • read_returns
    • read_script_tags
    • read_shipping
    • read_shopify_payments_payouts
    • read_content
    • read_store_credit_account_transactions
    • read_store_credit_accounts
    • read_own_subscription_contracts
    • read_themes
    • read_third_party_fulfillment_orders
    • read_translations
    • read_pixels
    Unauthenticated (Storefront) scopes
    • unauthenticated_read_bulk_operations
    • unauthenticated_read_bundles
    • unauthenticated_read_checkouts
    • unauthenticated_read_customers
    • unauthenticated_read_customer_tags
    • unauthenticated_read_metaobjects
    • unauthenticated_read_product_pickup_locations
    • unauthenticated_read_product_inventory
    • unauthenticated_read_product_listings
    • unauthenticated_read_product_tags
    • unauthenticated_read_selling_plans
    • unauthenticated_read_shop_pay_installments_pricing
    • unauthenticated_read_content
That’s 88 scopes total — 75 admin, 13 unauthenticated.

Add App URL : https://api.ocular.dev/shopify/install and click 'Release'

Shopify5

Create version → Release

Give a version name and release

Give a version name (optional) and click on release.
Shopify6

Release this new version?

Install App

Navigate back to the newly created app and click on Install App.
Shopify7

App overview → Install app

Select your brand name

Select your brand name (existing store on Shopify).
Shopify8

Choose a store → Brand name

Install the app

Install the app as seen on the screenshot.
Shopify9

Install app → Install

Copy the Client ID and Secret

To copy the Client ID and Secret, navigate back to the already opened app — under App settings you will find the required credentials. Alternatively, open the app’s settings page directly from the Dev Dashboard.
Shopify10

App settings → Credentials

Make a note of the credentials

On the App settings page, under settings, make a note of the client ID and secret. You will need it to configure Ocular.

​
Ocular App

Open the connector form

In Ocular, navigate to Data Management → Connectors → Add connector → Shopify.

Fill in the fields

  • Connector Name (free-form)
  • Connector Identifier
  • Start Date (YYYY-MM-DD) : this defines how far back in time Ocular should pull data from your Shopify store. Choose a date from which you want to begin analyzing your data.
  • Lookback Days : the number of past days from which data will be fetched during synchronization. This ensures that recent historical data is included and kept up to date. The default setting is 30 days.
  • Shop URL : You can find your shop name immediately before .myshopify.com in your Shopify URL. For example, if your URL is shopname.myshopify.com, then your shop name is shopname.
  • Client ID
  • Client Secret

Authorize with Shopify

Click on authorize with shopify.

Enter your Client ID and Client Secret

Enter your Client ID and Client Secret.Where to find Client ID & Client Secret:
Shopify10 1

App settings → Client ID and Secret

Click Connect

Click Connect. Ocular will take it from here and sync your data from your Shopify account.