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.
platform
PlatformThe underlying platform.
orgId
stringYour organization id.
{
"id": "00000000-0000-0000-0000-000000000000",
"platform": "SHOPIFY",
"orgId": "00000000-0000-0000-0000-000000000000"
}
Create a Connection
POST /connections/createRequest Body
All of:
platform
PlatformThe underlying platform.
scope
stringoptionalAny of:
BigCommerce Credentials
oauth_access_token
stringstore_url
stringoauth_client_id
stringoptionaloauth_client_secret
stringoptionalAmazon Credentials
oauth_client_id
stringoauth_client_secret
stringoauth_refresh_token
stringamazon_access_key_id
stringamazon_secret_access_key
stringamazon_selling_partner_role
stringamazon_seller_region
enumShopify Credentials
Any of:
Shopify Private Credentials
basic_username
stringbasic_password
stringstore_url
stringShopify Public Credentials
oauth_client_id
stringoauth_client_secret
stringoauth_access_token
stringstore_url
stringPrestaShop Credentials
store_url
stringapi_key
stringShoper Credentials
store_url
stringoauth_access_token
stringoauth_refresh_token
stringWooCommerce Credentials
store_url
stringbasic_username
stringbasic_password
stringMagento Credentials
store_url
stringbasic_username
stringbasic_password
stringEbay Credentials
oauth_client_id
stringoauth_client_secret
stringoauth_refresh_token
stringLazada Credentials
oauth_client_id
stringoauth_client_secret
stringoauth_access_token
stringoauth_refresh_token
stringcountry
stringFnac Credentials
partner_id
stringshop_id
stringkey
stringSquare Credentials
oauth_client_id
stringoauth_client_secret
stringoauth_refresh_token
stringStripe Credentials
oauth_access_token
stringaccount_id
stringQuickbooks Credentials
oauth_client_id
stringoauth_client_secret
stringoauth_refresh_token
stringrealm_id
stringenvironment
stringoptionalNetsuite Credentials
consumer_key
stringconsumer_secret
stringtoken_id
stringtoken_secret
stringstore_name
stringpublic_key
stringPlaid Credentials
client_id
stringsecret
stringaccess_token
stringenvironment
stringoptionalResponse Body
connection
objectconnection
attributesList Connections
GET /connectionsResponse Body
connections
arrayconnections
attributesFetch a Connection
GET /connections/access_tokenRequest Parameters
access_token
stringqueryThe access token of the connection.
Response Body
connection
objectconnection
attributesFetch a Connection Status
GET /connections/statusRequest Parameters
access_token
stringqueryThe access token of the connection.
Response Body
status
objectstatus
attributesconnection
objectconnection
attributesDelete a Connection
DELETE /connections/:idRequest Parameters
id
stringpathThe Rutter connection ID to delete.
Response Body
success
booleantrue
if the delete operation succeeded.
{
"success": true
}