Foundations

{
  "id": "00000000-0000-0000-0000-000000000000",
  "orgId": "00000000-0000-0000-0000-000000000000",
  "platform": "SHOPIFY"
}

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.

{
  "platform": "SHOPIFY",
  "oauth_client_id": "CLIENT_ID",
  "oauth_access_token": "ACCESS_TOKEN",
  "store_url": "shopifystore.myshopify.com",
  "oauth_client_secret": "CLIENT_SECRET"
}

{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "access_token": "00000000-0000-0000-0000-000000000000",
    "link_url": "https://link.rutterapi.com/connection/00000000-0000-0000-0000-000000000000"
  }
}

{
  "success": true
}

The Schedule 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.

{
  "success": true
}

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.

{
  "success": true
}