The Connection object
The Connections endpoints are used to manage Connections, which are the individual storefronts, payment processors, or accounting systems that businesses have shared with you. You can use these endpoints to create a new connection manually and send an authentication link directly to a merchant, or get access to the raw credentials for a specific platform (Shopify, WooCommerce, Quickbooks Online, etc.).
To understand the lifecycle of a Connection and the important events that occur when a merchant connects/disconnects their platform, see Connection Lifecycle.
Properties
id
stringThe UUID of the connection. Generated by Rutter.
orgId
stringYour organization id.
platform
enumThe underlying platform.
{
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "SHOPIFY"
}
Create a Connection
POST /versioned/connections/createCreate 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.
Request Body
All of:
platform
enumThe underlying platform.
scope
stringoptionalAny of:
Credentials for BigCommerce
oauth_client_id
stringoptionalBigCommerce App Client ID
oauth_access_token
stringBigCommerce Store Access Token
store_url
stringBigCommerce merchant .mybigcommerce.com domain URL
oauth_client_secret
stringoptionalBigCommerce App Client Secret
Credentials for Amazon
amazon_access_key_id
stringAWS User Access Key ID
oauth_client_id
stringSP-API App Client ID
amazon_secret_access_key
stringAWS User Secret Access Key
amazon_seller_region
enumRegion of Amazon seller - must be one of na (North America), eu (Europe), or fe (Far East).
amazon_selling_partner_role
stringAWS Role ARN used in SP-API app
oauth_client_secret
stringSP-API App Client Secret
oauth_refresh_token
stringSP-API Refresh Token
Any of:
Credentials for Shopify Private App
basic_password
stringPrivate Shopify App Password
basic_username
stringPrivate Shopify App API Key
store_url
stringShopify merchant .myshopify.com domain URL
Credentials for Shopify Public App
oauth_client_id
stringShopify Public App Client ID
oauth_access_token
stringShopify Merchant Access Token
oauth_client_secret
stringShopify Public App Client Secret
store_url
stringShopify merchant .myshopify.com domain URL
Credentials for PrestaShop
api_key
stringPrestaShop API Key
store_url
stringPrestaShop merchant domain URL
Credentials for Shoper
oauth_access_token
stringShoper merchant OAuth Access Token
oauth_refresh_token
stringShoper merchant OAuth Refresh Token
store_url
stringShoper merchant domain URL
Credentials for WooCommerce
basic_password
stringWooCommerce Rest API Consumer Secret
basic_username
stringWooCommerce Rest API Consumer Key
store_url
stringWooCommerce merchant website URL
Credentials for Magento
basic_password
stringMagento Admin User Password
basic_username
stringMagento Admin User Username
store_url
stringMagento merchant website URL
Credentials for eBay
oauth_client_id
stringEbay Developer OAuth Client ID
oauth_client_secret
stringEbay Developer OAuth Client Secret
oauth_refresh_token
stringEbay OAuth Refresh Token
Credentials for Lazada
oauth_client_id
stringOAuth Client ID
country
stringCountry Code for Merchant (e.g. id, sg, th)
oauth_access_token
stringOAuth Access Token
oauth_client_secret
stringOAuth Client Secret
oauth_refresh_token
stringOAuth Refresh Token
Credentials for Fnac
partner_id
stringPartner ID
shop_id
stringShop ID
key
stringKey
Credentials for Square
oauth_client_id
stringSquare Developer OAuth Client ID
oauth_client_secret
stringSquare Developer OAuth Client Secret
oauth_refresh_token
stringSquare OAuth Refresh Token
Credentials for Stripe
account_id
stringStripe Account ID
oauth_access_token
stringStripe OAuth Access Token
Credentials for Quickbooks
oauth_client_id
stringOAuth Client ID
realm_id
stringRealm ID
oauth_client_secret
stringOAuth Client Secret
oauth_refresh_token
stringOAuth Refresh Token
environment
stringoptionalEnvironment (e.g. sandbox)
Credentials for Netsuite
token_id
stringToken ID
consumer_key
stringConsumer Key
consumer_secret
stringConsumer Secret
store_name
stringStore Name (for sandbox you should put it in the form '1000000_SB1')
token_secret
stringToken Secret
Credentials for Walmart
oauth_client_id
stringWalmart Developer OAuth Client ID
oauth_client_secret
stringWalmart Developer OAuth Client Secret
Credentials for Xero
oauth_client_id
stringOAuth Client ID
tenant_id
stringThe Xero Tenant ID
user_id
stringThe Xero User ID
oauth_client_secret
stringOAuth Client Secret
oauth_refresh_token
stringOAuth Refresh Token
Response Body
connection
objectconnection
attributes{
"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"
}
}
List Connections
GET /versioned/connectionsResponse Body
connections
arrayconnections
attributesFetch a Connection
GET /versioned/connections/access_tokenRequest Parameters
access_token
stringqueryThe access token of the connection.
Response Body
connection
objectconnection
attributesFetch a Connection Status
GET /versioned/connections/statusRequest Parameters
access_token
stringqueryThe access token of the connection.
Response Body
connection
objectconnection
attributesstatus
objectstatus
attributesDelete a Connection
DELETE /versioned/connections/:idRequest Parameters
id
stringpathThe Rutter connection ID to delete.
Response Body
success
booleantrue
if the delete operation succeeded.
{
"success": true
}
Schedule Incremental Sync
POST /versioned/connections/incremental_syncThe 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.
Request Parameters
access_token
stringqueryThe access token of the connection.
Response Body
success
booleantrue
if the operation succeeded.
{
"success": true
}
Schedule Backfill
POST /versioned/connections/backfillThe 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.
Request Parameters
access_token
stringqueryThe access token of the connection.
Request Body
start_date
stringThe start date of the backfill, restricted to max 5 years ago (e.g. 2023-02-07).
end_date
stringoptionalThe end date of the backfill (e.g. 2023-03-14). If none provided, defaults to today.
entity
enumThe Rutter Entity for which you would like to create a backfill
include_webhooks
booleanoptionalYou can receive webhooks for updated/created objects found during the backfill if you are subscribed to them by including true
here. Defaults to false.
remarks
stringoptionalRemarks for why you are creating this backfill.
Response Body
success
booleantrue
if the operation succeeded.
{
"success": true
}