- About Hevo
- Hevo Features
- Hevo System Architecture
- Core Concepts
- Free Trials
- Regulatory Compliance
- Scheduling a Demo
- Hevo Support
- General FAQs
- Getting Started
- Creating an Account in Hevo
- Connecting Through SSH
- Connecting Through Reverse SSH Tunnel
- Using Google Account Authentication
- How Hevo Authenticates Sources and Destinations using OAuth
- Reauthorizing an OAuth Account
- Familiarizing with the UI
- Creating your First Pipeline
- Data Loss Prevention and Recovery
- Data Ingestion
- Types of Data Synchronization
- Ingestion Modes and Query Modes for Database Sources
- Ingestion and Loading Frequency
- Data Ingestion Statuses
- Deferred Data Ingestion
- Handling of Primary Keys
- Handling of Updates
- Handling of Deletes
- Hevo-generated Metadata
- Data Loading
- Loading Data in a Database Destination
- Loading Data to a Data Warehouse
- Optimizing Data Loading for a Destination Warehouse
- Manually Triggering the Loading of Events
- Scheduling Data Load for a Destination
- Loading Events in Batches
- Data Loading Statuses
- Data Spike Alerts
- Name Sanitization
- Table and Column Name Compression
- Parsing Nested JSON Fields in Events
- Data Flow in a Pipeline
- Familiarizing with the Pipelines UI
Working with Pipelines
- Best Practices for Creating Database Pipelines
- Creating a Pipeline
- Connectivity Check for RDBMS Sources
- Scheduling a Pipeline
- Modifying a Pipeline
- Prioritizing a Pipeline
- Viewing Pipeline Progress
- Pausing and Deleting a Pipeline
- Log-based Pipelines
- Troubleshooting Data Replication Errors
- Managing Objects in Pipelines
Python Code-Based Transformations
- Supported Python Modules and Functions
Transformation Methods in the Event Class
- Create an Event
- Retrieve the Event Name
- Rename an Event
- Retrieve the Properties of an Event
- Modify the Properties for an Event
- Fetch the Primary Keys of an Event
- Modify the Primary Keys of an Event
- Fetch the Data Type of a Field
- Check if the Field is a String
- Check if the Field is a Number
- Check if the Field is Boolean
- Check if the Field is a Date
- Check if the Field is a Time Value
- Check if the Field is a Timestamp
- Convert Date String to Required Format
- Convert Date to Required Format
- Convert Datetime String to Required Format
- Convert Epoch Time to a Date
- Convert Epoch Time to a Datetime
- Convert Epoch to Required Format
- Convert Epoch to a Time
- Get Time Difference
- Parse Date String to Date
- Parse Date String to Datetime Format
- Parse Date String to Time
- Examples of Python Code-based Transformations
Drag and Drop Transformations
- Special Keywords
Transformation Blocks and Properties
- Add a Field
- Change Datetime Field Values
- Change Field Values
- Drop Events
- Drop Fields
- Find & Replace
- Flatten JSON
- Format Date to String
- Format Number to String
- Hash Fields
- Mask Fields
- Modify Text Casing
- Parse Date from String
- Parse JSON from String
- Parse Number from String
- Rename Events
- Rename Fields
- Round-off Decimal Fields
- Split Fields
- Examples of Drag and Drop Transformations
- Effect of Transformations on the Destination Table Structure
- Transformation Reference
- Transformation FAQs
- Python Code-Based Transformations
- Using Schema Mapper
- Mapping Statuses
- Auto Mapping Event Types
- Manually Mapping Event Types
- Modifying Schema Mapping for Event Types
- Schema Mapper Actions
- Fixing Unmapped Fields
- Resolving Incompatible Schema Mappings
- Resizing String Columns in the Destination
- Schema Mapper Compatibility Table
- Limits on the Number of Destination Columns
- File Log
- Troubleshooting Failed Events in a Pipeline
- Mismatch in Events Count in Source and Destination
- Activity Log
- Can multiple Sources connect to one Destination?
- What happens if I re-create a deleted Pipeline?
- Why is there a delay in my Pipeline?
- Can I change the Destination post-Pipeline creation?
- How does changing the query mode affect data ingestion?
- Why is my billable Events high with Delta Timestamp mode?
- Can I drop multiple Destination tables in a Pipeline at once?
- How does Run Now affect scheduled ingestion frequency?
- Will pausing some objects increase the ingestion speed?
- Can I see the historical load progress?
- Why is my Historical Load Progress still at 0%?
- Why is historical data not getting ingested?
- How do I set a field as a primary key?
- How do I ensure that records are loaded only once?
- Events Usage
- Free Sources
Databases and File Systems
- Data Warehouses
- Connecting to a Local Database
- Amazon DocumentDB
- Amazon DynamoDB
- Generic MongoDB
- MongoDB Atlas
- Support for Multiple Data Types for the _id Field
- Example - Merge Collections Feature
Errors During Pipeline Creation
- Error 1001 - Incorrect credentials
- Error 1005 - Connection timeout
- Error 1006 - Invalid database hostname
- Error 1007 - SSH connection failed
- Error 1008 - Database unreachable
- Error 1011 - Insufficient access
- Error 1028 - Primary/Master host needed for OpLog
- Error 1029 - Version not supported for Change Streams
- SSL 1009 - SSL Connection Failure
- Troubleshooting MongoDB Change Streams Connection
- Troubleshooting MongoDB OpLog Connection
- Errors During Pipeline Creation
- Amazon RDS SQL Server
- Azure SQL Server
- Google Cloud SQL Server
- Generic SQL Server
- Troubleshooting SQL Server
- SQL Server FAQs
- Amazon Aurora MySQL
- Amazon RDS MySQL
- Azure MySQL
- Google Cloud MySQL
- Generic MySQL
- MariaDB MySQL
Errors During Pipeline Creation
- Error 1003 - Connection to host failed
- Error 1006 - Connection to host failed
- Error 1007 - SSH connection failed
- Error 1011 - Access denied
- Error 1012 - Replication access denied
- Error 1017 - Connection to host failed
- Error 1026 - Failed to connect to database
- Error 1027 - Unsupported BinLog format
- Failed to determine binlog filename/position
- Schema 'xyz' is not tracked via bin logs
- Errors Post-Pipeline Creation
- Errors During Pipeline Creation
- MySQL FAQs
- Amazon Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Azure PostgreSQL
- Google Cloud PostgreSQL
- Generic PostgreSQL
- Heroku PostgreSQL
Errors during Pipeline creation
- Error 1003 - Authentication failure
- Error 1006 - Connection settings errors
- Error 1011 - Access role issue for logical replication
- Error 1012 - Access role issue for logical replication
- Error 1014 - Database does not exist
- Error 1017 - Connection settings errors
- Error 1023 - No pg_hba.conf entry
- Error 1024 - Number of requested standby connections
- Errors Post-Pipeline Creation
- Errors during Pipeline creation
- PostgreSQL FAQs
- Troubleshooting Database Sources
- Amazon S3
- Azure Blob Storage
- FTP / SFTP
- Google Cloud Storage (GCS)
- Google Drive
- Google Sheets
- Android SDK
- Writing JSONPath Expressions
REST API FAQs
- Why does my REST API token keep changing?
- Can I use a bearer authorization token for authentication?
- Does Hevo’s REST API support API chaining?
- What is the maximum payload size returned by a REST API?
- How do I split an Event into multiple Event Types?
- How do I split multiple values in a key into separate Events?
- Jira Cloud
- QuickBooks Time
- Finance & Accounting Analytics
- Amazon Ads
- Apple Search Ads
- Facebook Ads
- Facebook Page Insights
- Firebase Analytics
- Google Ads
- Google Analytics
- Google Analytics 4
- Google Analytics 360
- Google Play Console
- Google Search Console
- Instagram Business
- LinkedIn Ads
- Microsoft Advertising
- Pinterest Ads
- SendGrid Webhook
- Salesforce Marketing Cloud
- Snapchat Ads
- TikTok Ads
- Twitter Ads
- YouTube Analytics
- Product Analytics
Sales & Support Analytics
- Help Scout
- Hub Planner
- Salesforce Bulk API V2
- Toggl Track
- From how far back can the Pipeline ingest data?
- Can I connect to a Source not listed in Hevo?
- Can I connect a local database as a Source?
- How can I push data to Hevo API?
- How do I connect a CSV file as a Source?
- Why are my selected Source objects not visible in the Schema Mapper?
- How does the Merge Table feature work?
- Familiarizing with the Destinations UI
- Amazon Aurora MySQL
- SQL Server
- Connecting to a Local Database
- Limitations of using MySQL as a Destination
- Structure of Data in the Amazon Redshift Data Warehouse
- Loading Data to an Amazon Redshift Data Warehouse
- Troubleshooting Amazon Redshift Destination
- Amazon Redshift FAQs
- Azure Synapse Analytics
- Clustering in BigQuery
- Partitioning in BigQuery
- Loading Data to a Google BigQuery Data Warehouse
- Near Real-time Data Loading using Streaming
- Troubleshooting Google BigQuery
- Google BigQuery FAQs
- Hevo Managed Google BigQuery
- Structure of Data in the Snowflake Data Warehouse
- Loading Data to a Snowflake Data Warehouse
- Troubleshooting Snowflake
- Snowflake FAQs
- Amazon Redshift
- Can I move data between SaaS applications using Hevo?
- Can I change the primary key in my Destination table?
- How do I change the data type of table columns?
- Can I change the Destination table name after creating the Pipeline?
- How can I change or delete the Destination table prefix?
- How do I resolve duplicate records in the Destination table?
- How do I enable or disable deduplication of records?
- Why does my Destination have deleted Source records?
- How do I filter deleted Events from the Destination?
- Does a data load regenerate deleted Hevo metadata columns?
- Can I load data to a specific Destination table?
- How do I filter out specific fields before loading data?
- How do I sort the data in the Destination?
- dbt™ Models
- Familiarizing with the Models UI
- Types of Models
- Key Features
- Working with SQL Models
- Previewing a Model
- Viewing the Query History
- Legacy Models
- Models FAQs
- Account Management
- Personal Settings
- Team Settings
- Pricing Plans
- Time-based Events Buffer
- Setting up Pricing Plans, Billing, and Payments
- On-Demand Purchases
- Billing Alerts
- Viewing Billing History
- Billing Notifications
- Can I get a plan apart from the Starter plan?
- Are free trial Events charged once I purchase a plan?
- For how long can I stay on the Free plan?
- How can I upgrade my plan?
- Is there a discount for non-profit organizations?
- Can I seek a refund of my payment?
- Do ingested Events count towards billing?
- Will Pipeline get paused if I exceed the Events quota?
- Will the initial load of data be free?
- Does the Hevo plan support multiple Destinations?
- Do rows loaded through Models count in my usage?
- Is Hevo subscription environment-specific?
- Can I pause billing if I have no active Pipelines?
- Can you explain the pricing plans in Hevo?
- Where do I get invoices for payments?
- Account Suspension and Restoration
- Account Management FAQs
- Activate Concepts
- Familiarizing with the Activate UI
- Working with Activate
- Activate Warehouses
- Activate Targets
- Release Notes
- Release Version 2.16.4
- Release Version 2.16.3
- Release Version 2.16.2
- Release Version 2.16.1
- Release Version 2.16
- Release Version 2.15
- Release Version 2.14
- Release Version 2.13
- Release Version 2.12
- Release Version 2.11
- Release Version 2.10
- Release Version 2.09
- Release Version 2.08
- Release Version 2.07
- Release Version 2.06
- Release Version 2.05
- Release Version 2.04
- Release Version 2.03
- Release Version 2.02
- Release Version 2.01
- Release Version 2.00
- Release Version 1.99
- Release Version 1.98
- Release Version 1.97
- Release Version 1.96
- Release Version 1.95
- Release Version 1.93 & 1.94
- Release Version 1.92
- Release Version 1.91
- Release Version 1.90
- Release Version 1.89
- Release Version 1.88
- Release Version 1.87
- Release Version 1.86
- Release Version 1.84 & 1.85
- Release Version 1.83
- Release Version 1.82
- Release Version 1.81
- Release Version 1.80 (Jan-24-2022)
- Release Version 1.79 (Jan-03-2022)
- Release Version 1.78 (Dec-20-2021)
- Release Version 1.77 (Dec-06-2021)
- Release Version 1.76 (Nov-22-2021)
- Release Version 1.75 (Nov-09-2021)
- Release Version 1.74 (Oct-25-2021)
- Release Version 1.73 (Oct-04-2021)
- Release Version 1.72 (Sep-20-2021)
- Release Version 1.71 (Sep-09-2021)
- Release Version 1.70 (Aug-23-2021)
- Release Version 1.69 (Aug-09-2021)
- Release Version 1.68 (Jul-26-2021)
- Release Version 1.67 (Jul-12-2021)
- Release Version 1.66 (Jun-28-2021)
- Release Version 1.65 (Jun-14-2021)
- Release Version 1.64 (Jun-01-2021)
- Release Version 1.63 (May-19-2021)
- Release Version 1.62 (May-05-2021)
- Release Version 1.61 (Apr-20-2021)
- Release Version 1.60 (Apr-06-2021)
- Release Version 1.59 (Mar-23-2021)
- Release Version 1.58 (Mar-09-2021)
- Release Version 1.57 (Feb-22-2021)
- Release Version 1.56 (Feb-09-2021)
- Release Version 1.55 (Jan-25-2021)
- Release Version 1.54 (Jan-12-2021)
- Release Version 1.53 (Dec-22-2020)
- Release Version 1.52 (Dec-03-2020)
- Release Version 1.51 (Nov-10-2020)
- Release Version 1.50 (Oct-19-2020)
- Release Version 1.49 (Sep-28-2020)
- Release Version 1.48 (Sep-01-2020)
- Release Version 1.47 (Aug-06-2020)
- Release Version 1.46 (Jul-21-2020)
- Release Version 1.45 (Jul-02-2020)
- Release Version 1.44 (Jun-11-2020)
- Release Version 1.43 (May-15-2020)
- Release Version 1.42 (Apr-30-2020)
- Release Version 1.41 (Apr-2020)
- Release Version 1.40 (Mar-2020)
- Release Version 1.39 (Feb-2020)
- Release Version 1.38 (Jan-2020)
- Upcoming Features
|Draft Order||- Addition of the poNumber field.|
|Order||- Addition of the poNumber, current_total_additional_fees_set, and original_total_additional_fees_set fields.
- Deletion of processing method field.
|Order Shipping Line||- Deletion of the device_category field.
Note: This is an outdated field and is being deprecated in version 2023-07.
|Transaction||- Addition of the credit_card_name, credit_card_wallet, credit_card_expiration_month, and credit_card_expiration_year fields.|
To avoid any data loss, we recommend that you make the necessary adjustments to accommodate these changes. If you need the historical data for any of the new fields, you can restart the historical load for the respective object.
This change applies to all new and existing Pipelines created with this Source.
Shopify uses the concept of a custom app to allow access to store data for a merchant. These custom apps function exclusively for your Shopify store unlike public apps, which are built to work with many stores. The app is configured with the requisite Admin API scopes to fetch the different types of data from the store using Shopify’s REST APIs. You must install this app to view the API token, which is then used to set up a Pipeline in Hevo with Shopify as the Source.
The transfer of data from your Shopify store to the Destination location, therefore, comprises the following one-time setups:
Creating an app in Shopify.
Assigning permissions to the app to read and transform the data using Shopify’s Rest API.
Creating a Pipeline in Hevo for transferring data from Shopify to the Destination database or data warehouse.
A Pipeline only transfers data to the specified Destination. You need to use appropriate tools for transforming the data for further analysis or for publishing it through your e-commerce portal. Read Models.
For creating Pipelines using this Source, Hevo provides you a fully managed BigQuery data warehouse as a possible Destination. This option remains available till the time you set up your first BigQuery Destination irrespective of any other Destinations that you may have. With the managed warehouse, you are only charged the cost that Hevo incurs for your project in Google BigQuery. The invoice is generated at the end of each month and payment is recovered as per the payment instrument you have set up. You can now create your Pipeline and directly start analyzing your Source data. Read Hevo Managed Google BigQuery.
A valid Shopify account.
Data types in Source and Destination are the same.
Perform the following steps to configure your Shopify Source:
Create an App in Shopify
As a first step of replicating data from your Shopify store to the desired Destination, you must create a custom app, using which, you can make API calls to your Shopify store and fetch data. To do this:
Log in to your Shopify Store Admin account.
In the left navigation pane, click Apps.
In the search bar, click App and sales channel settings.
In the Apps and sales channels page, click Develop apps.
Click Allow custom app development.
Click Allow custom app development again to allow Shopify to create custom apps.
In the App Development page, click Create an app.
In the Create an app dialog:
In the App name field, provide a name for the custom app.
In the App developer field, select the email address that Shopify should use for contacting you or your team member regarding your app. Read Update your developer contact details for steps to add or update the email address of your team member to the custom app.
Click Create app.
Click Configure Admin API scopes.
Refer to section, Configure API Permissions in Shopify for steps to configure the app to fetch all data from Shopify.
Configure API Permissions in Shopify
To configure the app to make API calls, you must grant the required permissions for the different scopes and the data within these scopes. Then, you must generate the API token to be used for setting up a Pipeline in Hevo with Shopify as the Source.
To grant the required permissions and generate the API token, perform the following steps:
Under the Admin API access scopes section, enable the
read_<scope_name>check box for the following scopes to get the read access:
Assigned Fulfillment Orders
Merchant Managed Fulfillment Orders
Shopify Payment disputes
Shopify Payment payouts
Third Party Fulfillment Orders
Click Install app.
In the confirmation dialog box, click Install.
In the API credentials tab, under the Admin API access token, click Reveal token once.
This shows your Admin API password that you must use while setting up a Shopify Pipeline in Hevo. The token is visible only once, so you must copy the token and store it in a secure location.
Configure Shopify Connection Settings
Once you have set up the app and generated the API credentials, create a Pipeline to complete the framework for replicating the data from Shopify into the Destination.
To do this:
Click PIPELINES in the Navigation Bar.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select Shopify.
In the Configure your Shopify Source page, specify the following:
Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.
Shop Name: Your shop name. You can find this in the address bar when logged into your shop. For example, in the URL https://mynewshop.myshopify.com/admin, the shop name is “mynewshop”.
Admin API Password: The password that you retrieved in Step 2 above.
No additional settings are needed, as Hevo connects to Shopify using the app details that you provide.
Historical Sync Duration: The duration for which the existing data in the Source must be ingested. Default duration: 3 Months.
Note: If you select All Available Data, Hevo ingests all the data available in your Shopify App account since January 01, 2006.
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.
Note:You can transfer data of all data types.
|Default Pipeline Frequency||Minimum Pipeline Frequency||Maximum Pipeline Frequency||Custom Frequency Range (Hrs)|
|10 Mins||5 Mins||24 Hrs||1-24|
Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.
Historical Data: In the first run of the Pipeline, Hevo ingests all the data for the selected objects in your Shopify App account.
For existing Pipelines: Hevo replicates object data for the past one year. Default duration: 1 Year.
For Pipelines created after Release 1.80: Hevo ingests historical data for all the objects on the basis of the historical sync duration selected at the time of creating the Pipeline. Default duration: 3 Months.
If you want data older or recent than this, use the Change Position option after creating the Pipeline. Hevo reloads the historical data as per the new position. If the new position is earlier than the current one and some or all of the historical data has already loaded, the consumption cost for the reloaded Events is incurred twice.
Incremental Data: Once the historical data is ingested, every subsequent run of the Pipeline fetches new and updated data.
Note: From Release 1.86, Hevo ingests only new and updated data for Full Load objects to optimize the quota consumption. This feature is currently available on request only. You need to contact Hevo Support to enable it for your team.
Handling of deletes
Hevo tracks deletes for only the Product object. For this, Hevo uses the events resource that records all the Events like creation, update, and deletion for other Shopify resources, such as the addition of a product or the fulfillment of an order. So, whenever Hevo encounters a delete event for the Product object, the value of the
__hevo__marked_deleted column for the record is set to True.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination database:
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline.
The table names are written in small case, except for the Snowflake data warehouse tables which are written in uppercase.
Hevo tracks deletes for the Product object only. Refer to section, Handling of deletes.
|Abandoned Checkout||Incremental||Contains the list of checkouts where the customer added the contact information but did not complete their purchase.|
|Application Charge||Full load||Contains details of the one-time charges paid by the merchant for their Shopify app. These charges apply to apps that are not billed on a recurring basis.|
|Application Credit||Full Load||Contains details of the credits issued to merchants that can be used for future transactions.|
|Balance||Full Load||Contains details of the current balance in your Shopify account.|
|Balance Transaction||Incremental||Contains details of funds moving in or out of your Shopify account.|
|Carrier Service||Full Load||Contains details of the shipping provider associated with your store.|
|Checkout Shipping Lines||Incremental||Contains details of the updates made to the shipping details of an order in the checkout stage.|
|Collect||Full Load||Contains details of the relationship between a product and a custom collection.|
|Country||Full Load||Contains details of the taxes levied on orders received from the countries in which the store sells its products.|
|Custom Collection||Incremental||Contains details of the groups created by the store owner to categorize its products.|
|Customer||Incremental||Contains details of the users of a store.|
|Customer Address||Incremental||Contains details of the addresses of a customer. Each Address object can contain multiple addresses for a customer.|
|Customer Journey Summary||Incremental||Contains details about the customer’s activity on your online store.|
|Customer Saved Search||Incremental||Contains details of search query used by the store owner to search and segregate customers according to its requirements.|
|Customer Visit||Incremental||Contains details of a session of a customer visiting your store.|
|Discount Allocation||Incremental||Contains details of the discount applied to products on the basis of the associated discounts available in the store.|
|Discount Code||Incremental||Contains details of the discount codes that customers can use while placing an order.|
|Dispute||Full Load||Contains details of the customer disputes about charges.|
|Draft Order||Incremental||Contains details of the orders that the store owner creates for the customers. These orders remain in the Draft state until the payment is received by the owner.|
|Draft Order Line Item||Incremental||Contains the list of line items present in a draft order.|
|Draft Order Note Attribute||Incremental||Contains details of the notes or additional details that the customer adds to the order.|
|Fulfillment||Incremental||Contains details of the orders that you deliver to the customers from the same or different location from which they placed the order.|
|Fulfillment Lines||Incremental||Contains the list of lines items present in a fulfillment order.|
|Inventory Level||Incremental||Contains details of the quantity of each inventory item available in a specific location.|
|Inventory Location||Full Load||Contains details of the locations where a merchant has its stores, pop-up stores, headquarters, and warehouses.|
|Marketing Event||Incremental||Contains details of the marketing campaigns done by your Shopify app for your store.|
|Metafield||Incremental||Contains details of the metadata information that you can add to any Shopify object.|
|Order||Incremental||Contains details of the customer purchases from your Shopify store.|
|Order Lines||Incremental||Contains the list of line items present in an order.|
|Order Note Attributes||Incremental||Contains details of the notes or additional details specified in an order.|
|Order Refund Lines||Incremental||Contains the list of line items refunded in an order.|
|Order Risk||Incremental||Contains details of the risk assessments and fraud checks done for an order, which might cause the merchant to cancel the order.|
|Order Shipping Lines||Incremental||Contains details of the shipping costs associated with an order.|
|Payout||Full Load||Contains details of the funds transfer between a Shopify Payments account and the merchant’s connected bank account.|
|Policy||Full Load||Contains details of the policies, such as refund and privacy policies, that the merchant has configured for its store.|
|Price Rule||Incremental||Contains details of the discounts that the store owner can create for its customers. They can apply these discounts on their orders only when the terms and conditions specified by the store owner are met.|
|Price Rule PreEntitled Collection||Incremental||Contains the list of product collections eligible for a discount in your store.|
|Price Rule PreEntitled Country||Incremental||Contains the list of shipping countries eligible for a discount in your store.|
|Price Rule PreEntitled Product||Incremental||Contains the list of products eligible for a discount in your store.|
|Price Rule PreEntitled Variant||Incremental||Contains the list of product variants eligible for a discount in your store.|
|Price Rule PreRequisite Collections||Incremental||Contains the list of product collections that a customer must buy to be eligible for a Buy A Get Bdiscount.|
|Price Rule PreRequisite Customer||Incremental||Contains the list of customers eligible for a discount.|
|Price Rule PreRequisite Product||Incremental||Contains the list of products that a customer must buy to be eligible for a Buy A Get B discount.|
|Price Rule PreRequisite Saved Search||Incremental||Contains details of the customer saved searches eligible for a discount.|
|Price Rule PreRequisite Variant||Incremental||Contains the list of product variants that a customer must buy to be eligible for a Buy A Get B discount.|
|Product||Incremental||Contains details of all items available for sale in a merchant’s store.|
|Product Image||Incremental||Contains details of the images for all the products in a merchant’s store.|
|Product Variant||Incremental||Contains details of the variants of the products in a merchants’ store, along with all possible combinations of these product variants.|
|Province||Incremental||Contains details of the sales tax charged from customers according to the sub-regions of the countries they place their order from.|
|Recurring Application Charge||Full Load||Contains details of the fixed charge that recurs every 30 days.|
|Refund||Incremental||Contains details of the funds returned to the customer for an order, and any updates on inventory for the line item(s) returned for that order.|
|Shipping Zone||Full Load||Contains details of the shipping rates for various countries, and provinces where the merchant sells it products.|
|Shop||Full Load||Contains details of the store(s) in your Shopify account.|
|Smart Collection||Incremental||Contains details of the product groups created by the merchant using some custom rules that he defined.|
|Tax Lines||Incremental||Contains details of the tax applied to a line item in an order.|
|Tender Transactions||Incremental||Contains details of the transfer of funds between the merchant and a customer. These transactions can be positive or negative if the funds are transferred by customer to merchant and vice-versa.|
|Transaction||Incremental||Contains details of the funds exchanged between the merchant and the customer for an order.|
|Usage Charge||Incremental||Contains details of the variable usage fee that is charged to the users along with the recurring application charge.|
Read the detailed Hevo documentation for the following related topics:
OAuth authentication is not supported in private apps.
Hevo captures deletes only for the Product object. Only deletes after Release 1.85 are captured.
Hevo does not capture cascading deletes of the Product object. In Shopify, a Product object can have child objects, Product Image, and Product Variant. When a product is deleted in Shopify, the associated images and variants are deleted as well. However, Hevo captures the information of the deleted product only, and not the images and variants associated with it.
Refer to the following table for the list of key updates made to this page:
|Date||Release||Description of Change|
|Sep-11-2023||NA||Added a warning container at the top of the page to mention about API migration.|
|Feb-20-2023||NA||Updated section, Configuring Shopify App as a Source to update the information about historical sync duration.|
|Jan-23-2023||2.06||- Updated section, Data Model with the two additional objects, Customer Journey Summary and Customer Visit, that Hevo now supports.
- Updated section, Schema and Primary Keys to add the new ERD link with two additional objects.
|Dec-07-2022||NA||Updated section, Create an App in Shopify according to the latest Shopify UI.|
|Oct-17-2022||1.99||Updated the section, Data Model with information about the new objects that Hevo ingests.|
|Jul-27-2022||NA||Updated Note in section, Data Replication.|
|May-23-2022||NA||Updated sections, Create an App in Shopify and Configure API Permissions in Shopify to include information about custom apps in Shopify.|
|Apr-11-2022||1.86||Added a note in section, Data Replication to inform about optimized quota consumption for Full Load objects.|
|Apr-11-2022||1.85||- Updated the section, Data Replication to add information about handling of deletes for the Product object.
- Added limitations about capturing deletes.
|Jan-24-2022||1.80||Added information about configurable historical sync duration in the Data Replication section.|
|Oct-25-2021||NA||Added the Pipeline frequency information in the Data Replication section.|
|Sep-09-2021||1.71||Updated the section, Data Model to mention the new objects that Hevo now ingests.|
|Jul-12-2021||1.67||Updated the Data Model section with additional objects that Hevo now supports and merged the Appendix into it.|
|Jun-14-2021||1.65||Updated the default historical load duration to one year in the Data Replication section and suggested the Change Position option to fetch Events beyond or more recent than one year.|