Shopify

Version 0.0.7

πŸ“˜

Checkout theΒ docs here for more information

Set up


Creating A Custom App

To set up the Shopify connector, you will need to create a custom app. To do this follow these steps. If you already have a custom set up please check the scopes:

  • Log in to your Shopify account
    • From the left-side menu click Apps
  • The search bar should pop up with options. At the bottom click App and sales channel settings
  • The settings modal should appear. In the top right there is an option Develop apps to the left of the green button
  • Click Create an app the big green button
  • Enter a name for the app and choose a user as the developer
  • Click Create app
  • Enable the necessary scopes for the reports from the list below. If you need to restrict scopes for security purposes please see the api docs for each report which will indicate which scopes are required.
  • Click Install app

πŸ“˜

Scopes

To have access to all reports the following scopes must be enabled 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

Credentials

  • To set up the source in the kleene app you will need your shop name and your Admin API access token.
  • Your shop name is everything in the URL preceding .myshopify.com. e.g.
    URL: https://hello-client.myshopify.com/admin/
    Shop name: hello-client
  • Your Admin API access token can be retrieved from the API credentials tab

Features


FeatureSupportNotes
Backfillβœ…All-time for all reports except Orders, Order Metafields and Transactions which are all restricted to 5 years but support variable backfill.
Incrementalβœ…Supported using the load method append on all reports except Locations.
API reliability🟒Reliable

Reports detail


⬇️ ReportπŸ”‘ Incremental keyπŸ”‘ Primary keyπŸ“„ Link to API endpoint✏️ Notes
Customersupdated_atidList all Customers
Customer Metafieldsupdated_atidList all Metafields For CustomersThis will potentially take more than one day to backfill
Discount Codesupdated_atidList all Discount Codes
Iventory Itemsupdated_atidList all Inventory Items
LocationsN/AidList all Locations
Ordersupdated_atidList all Orders
Order Metafieldsupdated_atidList all Metafields For OrdersThis will potentially take more than one day to backfill
Shopify Payment PayoutsdateidList all Payouts
Price Rulesupdated_atidList all Price Rules
Productsupdated_atidList all Products
Product Metafieldsupdated_atidList all Metafields For ProductsThis will potentially take more than one day to backfill
Product Variant Metafieldsupdated_atidList all Metafields For Product VariantsThis will potentially take more than one day to backfill
Transactionsorder_last_updated_atidList all TransactionsThis will potentially take more than one day to backfill