Shopify
Version 0.0.12
Checkout the docs here for more information
The 0.0.9 Shopify connector uses the API Version 2023-10
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
| Feature | Support | Notes |
|---|---|---|
| Backfill | ✅ | All-time for all reports except Orders, Order Metafields, Draft Orders and Transactions which are all restricted to 10 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 |
|---|---|---|---|---|
| Customers | updated_at | id | List all Customers | |
| Customer Metafields | updated_at | id | List all Metafields For Customers | This will potentially take more than one day to backfill |
| Discount Codes | updated_at | id | List all Discount Codes | |
| Draft Orders | updated_at | id | [List all Draft Orders] | |
| Fulfillments | order_last_updated_at | id | List all Fulfillments | This will potentially take more than one day to backfill |
| Inventory Items | updated_at | id | List all Inventory Items | |
| Inventory Levels | updated_at | location_id, inventory_item_id | List all Inventory Items | |
| Locations | N/A | id | List all Locations | |
| Orders | updated_at | id | List all Orders | |
| Order Metafields | updated_at | id | List all Metafields For Orders | This will potentially take more than one day to backfill |
| Shopify Payment Payouts | date | id | List all Payouts | |
| Price Rules | updated_at | id | List all Price Rules | |
| Products | updated_at | id | List all Products | |
| Product Metafields | updated_at | id | List all Metafields For Products | This will potentially take more than one day to backfill |
| Product Variant Metafields | updated_at | id | List all Metafields For Product Variants | This will potentially take more than one day to backfill |
| Transactions | order_last_updated_at | id | List all Transactions | This will potentially take more than one day to backfill |
Limitations
Backfill periods
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.
Updated about 2 months ago