Zync Docs
Help

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 recordMetafieldHolds
Productcustom.zoho_item_idThe Zoho item ID, or the item group ID for a product with several variants
Variantcustom.zoho_item_idThe Zoho item ID for that variant
Customercustom.zoho_contact_idThe Zoho contact ID
Ordercustom.zoho_order_idThe ID of the order's main Zoho document: the sales order, or the invoice with Invoice only
Ordercustom.zoho_sync_stateWhat 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.

WhenZync reads
A product syncs againThe product's item ID, and updates that item
An order line needs its itemThe variant's item ID
Stock syncsThe variant's item ID
An order needs its contactThe customer's contact ID
An order syncs againThe order's document ID and sync state

What Zync stores

DataPurpose
Your Zoho connectionClient ID and secret, tokens, region domains, module and organisation ID
Your settingsEverything you set on the Products, Orders, Customers and Connection pages, including location, tax, gateway and product mappings
Sync logsOne row per sync result: type, status, message and the Shopify and Zoho IDs
Short-lived working dataJob 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 recordReference
Sales order and invoiceReference number is the Shopify order name, for example #1001
Customer paymentA reference derived from the Shopify payment transaction
Credit noteA reference derived from the Shopify refund

Privacy requests and uninstalling

EventWhat Zync does
A customer asks for their dataZync gathers the sync logs that concern that customer and their orders, for support to pass on
A customer is to be erasedZync deletes the sync logs for that customer and their orders
You uninstall the appYour sessions are removed and syncing stops
Shopify asks for the shop's data to be erased, 48 hours after uninstallZync 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.