Skip to main content

Setup Shopify source

Updated

Pulls orders, products, customers, fulfilments, discounts and payouts from Shopify using a custom app's Admin API access token.

Setup at a glance

  1. 01ShopifyAcquire credentials
  2. 02KleeneComplete Setup
  3. Connected
  • Connector type API
  • Auth method Custom app — Admin API access token

Before you start

  • Access to your Shopify account so you can create a custom app

Connect Shopify to Kleene

  1. Get your Shopify credentials

    1. Log in to your Shopify account. From the left-side menu click Apps.
    2. The search bar should pop up with options. At the bottom, click App and sales channel settings.
    3. The settings modal should appear. In the top right there is an option Develop apps, to the left of the green button — click it.
    4. Click Create an app (the big green button).
    5. Enter a name for the app and choose a user as the developer, then click Create app.
    6. Enable the necessary scopes for the reports you need — see the list below.
    7. Click Install app.
    8. Retrieve your Admin API access token from the API credentials tab.

    To have access to all reports, enable all of these scopes on your custom app.

    • read_products
    • read_customers
    • read_orders
    • read_price_rules
    • read_fulfillments
    • read_shipping
    • read_draft_orders
    • read_inventory
    • read_shopify_payments_payouts
    • read_shopify_payments_disputes
    • read_content
    • read_themes
    • read_product_listings
    • read_locations
    • read_script_tags
    • read_assigned_fulfillment_orders
    • read_merchant_managed_fulfillment_orders
    • read_third_party_fulfillment_orders
    • read_discounts
    • read_locales

    Already have a custom app set up? You still need to check its scopes against the list above.

  2. Add the source in Kleene

    1. In the Kleene app, go to Add a source.
    2. Scroll down or search for Shopify.
    3. Click Connect to open the credentials panel.

  3. Enter your credentials and connect

    • Shop nameEverything in the URL preceding .myshopify.com — e.g. for https://hello-client.myshopify.com/admin/ enter hello-client
    • Admin API access token

    The new source now appears on the Sources screen.

Before you extract — Shopify limits and report notes

This guide covers source setup only. When you move on to creating extracts, these are the connector-specific things to know.

Connector capabilities

Backfill Yes — all-time for all reports except Orders, Order Metafields, Draft Orders and Transactions, which are restricted to 10 years but support variable backfill
Incremental Yes — using the append load method, on all reports except Locations and Order Metafields (Custom)
API reliability Reliable

Available reports

Reports cover orders, products, customers, fulfilments, discounts, inventory, locations, metafields and Shopify Payment Payouts. See the full Shopify report list on docs.kleene.ai for every report with its incremental and primary keys.

Extract notes

  • Some reports can potentially take more than one day to backfill — Customer Metafields, Fulfillments, Product Metafields, Product Variant Metafields and Transactions.
  • If you encounter issues landing the Order Metafields extract, use the Order Metafield (Custom) report to request a smaller backfill range.

Limitations

  • The longest backfill option of 10 years can result in long report run times, and is only advisable if you have reports scheduled to run at separate times.

Vendor reference: Shopify Admin REST API docs

Related to

Powered by Zendesk