Shopify (Edge)

Shopify is an e-commerce platform that enables businesses to create and manage online stores, including products, orders, customers, inventory, and payments. It provides APIs that allow access to store data for analytics and reporting.

To connect Hevo with Shopify, you need to create a custom app in your Shopify store. Unlike public apps that work across many stores, a custom app is built exclusively for your store and gives Hevo secure, scoped access to your data via Shopify’s GraphQL Admin API. You configure the app with the required Admin API permissions to control exactly which data Hevo can fetch. You must install this app in your store to set up a Pipeline in Hevo with Shopify as the Source.

---

Supported Features

---

Configure Webhooks for Capturing Delete Events

Shopify does not provide a direct API to retrieve deleted records. To capture delete events, Hevo relies on Shopify webhooks. You must configure these webhooks in your Shopify store using the webhook URL generated for your Pipeline.

Once configured, whenever records are deleted in Shopify, Hevo captures the event and marks the corresponding records in the Destination with the metadata column __hevo__marked_deleted = true. The record is not removed from your Destination. It is retained and flagged so you can identify deleted records in your data. This update is applied during the next incremental sync.

Perform the following steps to configure webhooks for capturing delete events:

1. Obtain the Webhook URL for your Pipeline

2. Create Webhooks in your Shopify Store

Obtain the Webhook URL for your Pipeline

Hevo generates a unique webhook URL for each Pipeline. You will need this URL when configuring webhooks in Shopify. Perform the following steps to obtain the webhook URL:

1. In the Pipeline’s toolbar, click Pipeline Setup.

   

2. Scroll down to the Configure Pipeline section and copy the URL displayed in the Webhook URL field.

   

Create Webhooks in your Shopify Store

Perform the following steps to create webhooks in your Shopify store:

1. Log in to your Shopify Store Admin account.

2. In the bottom left corner of the page, click Settings.

   

3. In the left navigation pane, click Notifications.

   

4. On the Notifications page, click Webhooks.

   

5. Click Create webhook.

   

6. In the pop-up dialog, specify the following:

   

   • Event: Select the required delete event (see list below).
   • Format: JSON
   • URL: Paste the webhook URL obtained from your Hevo Pipeline.
   • Webhook API version: Select your preferred webhook version.

7. Click Save.

Repeat these steps to create webhooks for all required delete events. You must configure webhooks for the following delete events to ensure complete delete capture:

• Checkout deletion
• Collection deletion
• Companies deletion
• Company contacts deletion
• Customer deletion
• Customer segment deletion
• Draft order deletion
• Fulfillment events deletion
• Inventory items deletion
• Order deletion
• Product deletion

Note: If you have configured additional webhook topics, Shopify may send extra events to the webhook URL. These events are ignored by Hevo and do not affect data ingestion.

---

Handling of Deletes

Shopify’s GraphQL API does not provide a direct method to retrieve deleted records. If you have configured additional webhooks, Hevo handles deletes differently depending on the object type, using one of two approaches described below:

Approach 1: Webhook-based delete capture (selected objects)

For the parent objects listed below, Hevo captures delete events using Shopify webhooks. When a record is deleted in Shopify, Hevo marks the corresponding record in your Destination with the metadata column __hevo__marked_deleted = true during the next incremental sync. The record is retained in your Destination and flagged rather than removed.

To enable this, you must configure webhook subscriptions for the required delete events in your Shopify store using the webhook URL generated for your Pipeline. See Configure Webhooks for Capturing Delete Events for setup instructions.

• checkout
• collection
• company
• company_contact
• customer_segment
• customer
• draft_order
• fulfillment_event
• inventory_items
• order
• product

Approach 2: Full dataset reload (all other objects)

For objects not listed above, Hevo reloads the complete dataset from Shopify on every Pipeline run. Records present in your Destination that are not returned in the latest API response are automatically marked with __hevo__marked_deleted = true. No webhook configuration is required for these objects.

Note: Child objects do not support delete capture through either approach. As the child object tables are fully reloaded on every sync, any deleted child records are automatically removed from the Destination in the next Pipeline run.

---

Source Considerations

• Hevo replicates metafields as child tables for the following objects:

  • collection
  • customer
  • draft_order
  • order
  • product
  • product_image
  • product_variant
  • shop

  Since metafields can significantly increase data volume for high-volume objects such as product or order, enable metafield child objects only if your use case specifically requires this data.

• Updates made directly to child objects in Shopify do not always update the parent object’s updated_at timestamp. As a result, incremental syncs, which rely on the parent object’s timestamp, may not capture certain child object updates. If data accuracy for child objects is critical for your use case, you can resync the objects when required.

---

Limitations

• Certain Shopify child objects can be associated with multiple parent record types, where the exact parent type varies per record. For example, a discount_customer_buys_product child object could belong to either a discount_automatic_bxgy or a discount_code_bxgy parent, depending on the record. Since Hevo requires a fixed parent-child mapping, this child objects cannot be ingested. Currently, Hevo supports only fixed parent-child relationships, where each child object maps to a single, well-defined parent table. As a result, child objects that require association with multiple possible parent types are not supported for ingestion.

  Note: The parent objects themselves are fully supported and ingested.

  The following table lists the affected child objects along with the possible parent types they depend on:

  Parent Objects	Unsupported Child Objects
  - discount_automatic_basic - discount_automatic_bxgy - discount_code_basic - discount_code_bxgy	- discount_customer_buys_collection - discount_customer_buys_product - discount_customer_buys_product_variant - discount_customer_gets_collection - discount_customer_gets_product - discount_customer_gets_product_variant
  - discount_code_app - discount_code_bxgy - discount_code_basic - discount_code_free_shipping	- discount_customer_segment_selection - discount_customer_selection - discount_redeem_code - discount_shareable_url
  - discount_automatic_free_shipping - discount_code_free_shipping	- discount_destination_selection_country