Data and metafields
The metafields Zync writes to your Shopify records, what Zync stores, and what happens to it when you uninstall.
Zync keeps the link between a Shopify record and its Zoho record on the Shopify record itself, as a metafield. This page lists those metafields and the data Zync stores.
Metafields Zync writes
All of them are in the custom namespace.
| Shopify record | Metafield | Holds |
|---|---|---|
| Product | custom.zoho_item_id | The Zoho item ID, or the item group ID for a product with several variants |
| Variant | custom.zoho_item_id | The Zoho item ID for that variant |
| Customer | custom.zoho_contact_id | The Zoho contact ID |
| Order | custom.zoho_order_id | The ID of the order's main Zoho document: the sales order, or the invoice with Invoice only |
| Order | custom.zoho_sync_state | What has already been done for the order in Zoho |
You can see them on a record in the Shopify admin under Metafields, once you have added a definition for them, or with any metafield tool.
The sync state
custom.zoho_sync_state is a small JSON record. It notes:
- Which kind of document the order has, and the invoice ID.
- Which Shopify payments have been recorded, and their Zoho payment IDs.
- Which refunds have a credit note, and whether each is settled.
- Which shipments have been written to the sales order.
- Whether the documents were voided.
This is how Zync knows what is left to do when an order syncs again, and why nothing is created twice.
Do not edit these metafields by hand
Changing or deleting them makes Zync treat the record as new, or as partly done. To detach a product from Zoho, use Unlink product from Zoho on the Product Sync tab.
What links are used for
| When | Zync reads |
|---|---|
| A product syncs again | The product's item ID, and updates that item |
| An order line needs its item | The variant's item ID |
| Stock syncs | The variant's item ID |
| An order needs its contact | The customer's contact ID |
| An order syncs again | The order's document ID and sync state |
What Zync stores
| Data | Purpose |
|---|---|
| Your Zoho connection | Client ID and secret, tokens, region domains, module and organisation ID |
| Your settings | Everything you set on the Products, Orders, Customers and Connection pages, including location, tax, gateway and product mappings |
| Sync logs | One row per sync result: type, status, message and the Shopify and Zoho IDs |
| Short-lived working data | Job queues, the Zoho API limit pause, and AI match results, which are kept for 24 hours |
Zync does not keep a copy of your orders, customers or products. It reads them from Shopify when a sync runs and sends them to Zoho.
References Zync writes in Zoho
So that records can be found again without the metafields:
| Zoho record | Reference |
|---|---|
| Sales order and invoice | Reference number is the Shopify order name, for example #1001 |
| Customer payment | A reference derived from the Shopify payment transaction |
| Credit note | A reference derived from the Shopify refund |
Privacy requests and uninstalling
| Event | What Zync does |
|---|---|
| A customer asks for their data | Zync gathers the sync logs that concern that customer and their orders, for support to pass on |
| A customer is to be erased | Zync deletes the sync logs for that customer and their orders |
| You uninstall the app | Your sessions are removed and syncing stops |
| Shopify asks for the shop's data to be erased, 48 hours after uninstall | Zync deletes your logs, settings and Zoho connection |
Records in your Zoho organisation, and the metafields on your Shopify records, belong to you and are not removed. If you install Zync again, the metafields let it pick up where it left off.