Integration
Xero and Shopify
Shopify back to Xero. Both directions are separate sync products, configured independently, and this page shows what the shipped catalogue sets up for this pair.
- No Phase 1 for this pair
- Phase 2 · write-back
In plain wordsChanges made in Shopify are carried back to Xero. There is no shipped forward sync into Shopify for this pair.
This page documents what the shipped catalogue sets up. For the commercial overview of the same pair — editions, licensing and how to buy it — Commercient publishes Xero to Shopify integration on commercient.com .
Phase 1 — Xero to Shopify
Phase 2 — Shopify back to Xero
What you getChanges made in Shopify to Customer, Order, Sales invoice, products are carried back to Xero.
| Process | What it delivers | Source → destination | Templates | Operations |
|---|---|---|---|---|
| Contact Import | Shopify Customer to Xero Contact | Customer → Customer | 1 | create |
| Invoice Import | Shopify Order to Xero Sales invoice | Order → Sales invoice | 1 | create |
| Product Items Import | Shopify Product to Xero Product | Product → Product | 1 | create |
Objects moved
- Customer
- Order
- Sales invoice
- Product
Setting up Xero and Shopify from the CLI
One wizard stands the tenant up, and it is the same five steps for every pair: register, capture the server IP, connect the CRM, declare the ERP connector, then import and enable the sync processes. What changes between pairs is the CRM’s connection mode and the ERP’s connector type.
1. Register the tenant
Registration creates the account, emails a verification link, and — once the Data Lake is seeded — prints a once-only bootstrap API key valid for seven days. The three consent flags are the registrant’s own decision, and the server refuses start without all three.
# which instance types sign-up accepts - run this first and use Xero's code below
$ dlake register erps
# the three consent flags are the registrant’s decision - ask before passing them
$ dlake register start --generate-password \
$ --email <email> --company "<Company Name>" --phone <tel> \
$ --instance-type <code from dlake register erps> \
$ --consent-crm-backup --consent-erp-backup --consent-phone
# after the human clicks the verification link: watch for the seed and catch the key
$ dlake register status --watch
# the bootstrap key expires in 7 days - mint a durable one while it is still valid
$ dlake admin create_api_key --keyName "<tenant>-setup" --expirationDays 90
2. Connect Shopify and declare Xero
Steps 3 to 5 of the wizard are admin-plane tools, they are safe to re-run, and the server enforces their order — attempt the CRM step before the server IP is captured and it answers 409 naming the step you skipped.
# the authoritative answer to where a registration got to - first call when resuming
$ dlake admin registration_state
# step 3: record the server IP (a prerequisite for the CRM step)
$ dlake admin registration_capture_server_ip --ipAddress <ip>
# step 4: the catalog lists every CRM with its authMode and the fields it needs
$ dlake admin registration_crm_catalog
$ dlake admin registration_crm_select --crmName Shopify
# an OAuth CRM: the catalog’s callbackMode says which leg this one takes
$ dlake registration oauth --crm Shopify
$ dlake admin registration_crm_finalize
# step 5: the catalog lists the connector types and the fields each one needs
$ dlake admin registration_connector_catalog
$ dlake admin registration_connector_submit \
$ --connectorType <type from the catalog> --erpName <Xero code> --fields @fields.json
$ dlake admin registration_connector_provision
$ dlake admin registration_provisioning_status
The wizard in full, including resuming a setup days later: Setting up an integration with dlake · Registering a new Data Lake.
0Source on GitHub
This page is generated from the skill pages in the dlake CLI repository. Those pages are the authority; if they disagree with anything here, they are right.
Xero and Shopify: common questions
Which way does data move between Xero and Shopify?
One way. Phase 2 (TxDownloaderPro) carries changes made in Shopify back to Xero. The repository ships no CRMPro forward sync for this pair, so there is no supported Phase 1 from Xero into Shopify.
What do Phase 1 and Phase 2 mean?
They are the two sync products the on-premises agent can run. Phase 1 is CommercientCRMPro, product 11, the forward sync from the source system into the CRM. Phase 2 is CommercientTxDownloaderPro, product 22, the write-back in the other direction. Registering a product says what to run; the Phase 1 and Phase 2 configuration says what it runs on.
Can I push Xero records into Shopify?
Not with a shipped forward sync. The repository carries no CRMPro page for Xero into Shopify, only the TxDownloaderPro write-back in the other direction. Treat any forward sync for this pair as unsupported unless the catalogue gains one.
What does the write-back from Shopify create in Xero?
The default set ships 3 processes for this pair: Contact Import, Invoice Import, Product Items Import. Each one takes a saved query against Shopify, an inbound mapping document, and writes the result into Xero.
Which objects does the write-back move?
Customer, Order, Sales invoice, Product. Those are the kinds of Shopify record the shipped processes carry back to Xero.
What does "Phase 2 ready" mean?
It means the tenant has at least one TxDownloaderPro process. Creating a process with txdownloaderpro_create_process is what flips a customer to Phase 2 ready; registering the product alone does not, because registering says what to run and the configuration says what it runs on.
View moreShow less
How do I see the write-back processes and whether they are failing?
dlake admin txdownloaderpro_list_processes returns every Phase 2 process with its 30-day unresolved-error count, which is the same grid the portal shows. txdownloaderpro_get_process returns one process in its edit shape, including the query and both mapping documents.
Can an AI agent set this up?
Yes, over the admin control plane or the CLI — the same tools either way. The txdownloaderpro_* tools cover listing, reading, creating and updating processes. They need a full-scope key that belongs to a user holding the Admin role, and every write is audited.
Where is the authoritative source for this pair?
The skill pages in the dlake CLI repository, which is where this page is generated from. The write-back page is linked at the foot of the integration page, and the same text is readable in the terminal with dlake skills show.
Related
Every ERP and CRM integration · CRMPro (forward sync) · TxDownloaderPro (writeback sync) · AI agents & MCP · Shopify integrations on commercient.com
