Sync Inc

Shopify Reference

Shopify is in closed alpha! If you'd like early access, send us a note.

The syncing process

Sync Inc workers first backfill your database with all your Shopify data by paginating through all Shopify REST API endpoints.

Then, after the backfill, we monitor Shopify Webhooks to apply any creates, updates, or deletes within a couple seconds.

Writes

Your Sync Inc database is read-only.

We advocate for a one-way data flow: read from your Sync Inc database, write to Shopify's API. Any changes will flow down to your Sync Inc database for you to read again.

Sometimes, you want to make sure that changes that you just wrote have been synced to your database. We call this scenario a read-after-write.

To do so, you can call our wait endpoint. To find the URL for your sync's wait endpoint, just click "Connect" in the Sync Inc console. Wait endpoints take this form:

https://api.syncinc.so/api/wait/:kind/:id

Where `kind` is the platform, like `stripe` or `close`. `id` is the Sync Inc ID of your sync.

A wait endpoint only returns after we've confirmed your database is up-to-date. So, you can weave it into your workflow like this:

  1. Make a write request directly to the API
  2. Call your sync's wait endpoint
  3. When #2 completes, read from your Sync Inc database

Here's an example curl request to a wait endpoint on Sync Inc:

> curl https://api.syncinc.so/api/wait/shopify/0f062f20-ac57-4c00-8e69-cfb1cbcfdd5f
< { "ok": true }

Note: The wait endpoint is in alpha and experimental. We may add additional properties to the response in the near future.

Setup
Setup

Was this helpful?