Data integration

This page covers how to connect your store to Shopify, how to review and reprocess the data Shopify sends you, and how to check the record of anything written back to Shopify.

Connecting to Shopify

Set this up in the Webtop Commerce app, under Connection → Shop.

  • Admin API (four fields: shop domain, API version, client ID, and client secret): once all four are filled in, product, inventory, and order data can flow between your store and Shopify. This only becomes active once every field is set.
  • Webhook shared secret: you normally don't need to set this. Notifications registered automatically (see "Registering webhooks" below) are verified correctly without it. Only set it if you create a notification manually in Shopify's own admin screen — it's needed to verify that one.

Registering webhooks

To receive notifications from Shopify about changes — new orders, product updates, inventory changes, refunds, and so on — Shopify first needs to be told where to send them. Once the Admin API connection above is set up, go to the Webtop Commerce app, Connection → Webhooks, enter your site's callback URL, and click the button. This registers everything you need in one step. The same screen also shows you what's currently registered, so you can confirm it went through.

Reviewing and reprocessing incoming data

Everything Shopify sends is kept as a history, so you can review it later and reprocess it if needed. In the Commerce Events app, filter by status (success, error, and so on), type, or date range, and reprocess items either one at a time or as a batch.

Items that fail are automatically retried after a short wait, up to a set number of attempts. If an item still hasn't gone through after all the automatic retries, reprocess it manually from the history.

Writing data back to Shopify

Actions such as recording shipment details, updating product information, or changing prices and stock levels are performed from their own screens (Commerce Product, order fulfillment, and so on), and each of these sends the update back to Shopify. This requires the Admin API connection to be set up. Until it is, any action that would normally write back to Shopify is simply skipped, and only your own records are updated.

You can review and download the full record of every write-back attempt — successes and failures alike — in the Commerce Oplog app.