Connections

• 

  Shopify
• 

  QuickBooks
• 

  WooCommerce
• 

  Amazon

The Connection Status endpoint allows you to retrieve information about a connection's historical and recent data syncs.

Not every platform has detailed support for sync information about each data object, e.g. fields within the total property. If a platform does not support a metadata field, the value will be null.

Create connections programmatically using the Create a Connection API. There are two ways to use this API:

• Create a connection that allows the merchant to select which platform they want to connect. This is done by leaving the request body empty.
• Create a connection with existing credentials. This is done by specifying the platform and including the associated credentials (OAuth, Basic Auth, etc.) for the connection. Rutter will use these fields to make the authenticated API requests to the platform. To see what values are required for each platform, see the Platform Specific Required Body Params table below or contact support@rutterapi.com for more support.

Connection URL

One of the returned fields in the connection object from the Create a Connection endpoint is the link_url, which is a unique, stable link that you can send to a business for Business Authentication.

The link_url points to the Rutter Link web app, which handles the authentication flow for each Ecommerce platform. Once the merchant completes the Link authentication flow, a CONNECTION_UPDATED event will be fired to your Webhook URL, and you will be able to fetch data for their store through this Connection.

There are a few query parameters that you can specify to a connection URL to customize the authentication experience. Here are some examples:

Loads the authentication flow directly to the Wix-specific step: https://link.rutterapi.com/connection/123?platform=wix

Loads the authentication flow directly to the Wix-specific step and on completion the merchant will be redirected to Google: https://link.rutterapi.com/connection/123?platform=wix&redirect_url=https%3A%2F%2Fwww.google.com

The Trigger Incremental Sync API endpoint allows you to manually trigger an Incremental Sync for a given connection. This will sync all objects that have been updated or created since the last sync. An example of when you may want to trigger an Incremental Sync is if you know new objects have been created in a platform, and you want to sync these new objects as soon as possible (rather than wait for Rutter's scheduled Incremental Sync to run).

NOTE: This functionality should only be used on a one-off basis. Rutter automatically schedules Incremental Syncs periodically and one doesn't typically need to make this API call except in rare cases. For each Incremental Sync triggered, Rutter may skip that many scheduled Incremental Syncs.

After receiving a success response, a sync will be queued and started shortly. You will begin to receive webhooks for updated/created objects if you are subscribed to them.

A connection's access_token is unique and does not expire. To rotate the access_token for a connection, you can use the /connections/access_token/invalidate endpoint. This endpoint generates a new access_token while invalidating the old one.

The Schedule Backfill API endpoint allows you to manually trigger a data backfill for a given connection. This will sync all data from the start date until now for the Rutter object provided. An example is if you make an update to an existing connection's Data Fetch Configuration, and you want to sync all historical data for the new objects you've added into the Data Fetch Configuration.

NOTE: This functionality should only be used on a one-off basis. If you trigger a Backfill, this will pause the scheduled Incremental Syncs that Rutter automatically performs for the connection until the Backfill is complete.

After receiving a success response, a sync will be queued and started shortly.