Shopify App

Last updated on Sep 03, 2024

From Release 2.16.3 onwards, Hevo uses version 2023-07 of the Shopify API to fetch your data. This change impacts the following objects:

Objects Changes
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.


Limitations

  • 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.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Mar-05-2024 2.21 Updated the ingestion frequency table in the Data Replication section.
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.

Tell us what went wrong