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
idstringThe UUID of the connection. Generated by Rutter.
platformPlatformThe underlying platform.
One ofSHOPER, SHOPIFY, SHOPWARE, MAGENTO, BIG_COMMERCE, WOO_COMMERCE, SQUARESPACE, WIX, SQUARE, COMMERCELAYER, AMAZON, ETSY, EBAY, PRESTASHOP, WEBFLOW, LAZADA, FNAC, ALIBABA, SHOPEE, MERCADOLIBRE, GUMROAD, SHOPLAZZA, WALMART, STRIPE, PAYPAL, QUICKBOOKS, QUICKBOOKS_DESKTOP, ECWID, XERO, FRESHBOOKS, NETSUITE, SAGE_BUSINESS_CLOUD, SAGE_INTACCT, ZOHOBOOKS, WAVE, DYNAMICS365, CHARGIFY, CHARGEBEE, RECURLY, or PLAID.
orgIdstringYour organization id.
Example Connection Object
{
"id": "00000000-0000-0000-0000-000000000000",
"platform": "SHOPIFY",
"orgId": "00000000-0000-0000-0000-000000000000"
}
Create a Connection
POST /connections/createSupported for: AmazonBigCommerceEbayFnacLazadaMagentoNetSuitePlaidPrestaShopQuickBooksShoperShopifySquareStripeWooCommerce
Request Body
All of:
platformPlatformThe underlying platform.
One ofSHOPER, SHOPIFY, SHOPWARE, MAGENTO, BIG_COMMERCE, WOO_COMMERCE, SQUARESPACE, WIX, SQUARE, COMMERCELAYER, AMAZON, ETSY, EBAY, PRESTASHOP, WEBFLOW, LAZADA, FNAC, ALIBABA, SHOPEE, MERCADOLIBRE, GUMROAD, SHOPLAZZA, WALMART, STRIPE, PAYPAL, QUICKBOOKS, QUICKBOOKS_DESKTOP, ECWID, XERO, FRESHBOOKS, NETSUITE, SAGE_BUSINESS_CLOUD, SAGE_INTACCT, ZOHOBOOKS, WAVE, DYNAMICS365, CHARGIFY, CHARGEBEE, RECURLY, or PLAID.
scopestringoptionalAny of:
BigCommerce Credentials
oauth_access_tokenstringstore_urlstringoauth_client_idstringoptionaloauth_client_secretstringoptionalAmazon Credentials
oauth_client_idstringoauth_client_secretstringoauth_refresh_tokenstringamazon_access_key_idstringamazon_secret_access_keystringamazon_selling_partner_rolestringamazon_seller_regionenumOne ofna, eu, or fe.
Shopify Credentials
Any of:
Shopify Private Credentials
basic_usernamestringbasic_passwordstringstore_urlstringShopify Public Credentials
oauth_client_idstringoauth_client_secretstringoauth_access_tokenstringstore_urlstringPrestaShop Credentials
store_urlstringapi_keystringShoper Credentials
store_urlstringoauth_access_tokenstringoauth_refresh_tokenstringWooCommerce Credentials
store_urlstringbasic_usernamestringbasic_passwordstringMagento Credentials
store_urlstringbasic_usernamestringbasic_passwordstringEbay Credentials
oauth_client_idstringoauth_client_secretstringoauth_refresh_tokenstringLazada Credentials
oauth_client_idstringoauth_client_secretstringoauth_access_tokenstringoauth_refresh_tokenstringcountrystringFnac Credentials
partner_idstringshop_idstringkeystringSquare Credentials
oauth_client_idstringoauth_client_secretstringoauth_refresh_tokenstringStripe Credentials
oauth_access_tokenstringaccount_idstringQuickbooks Credentials
oauth_client_idstringoauth_client_secretstringoauth_refresh_tokenstringrealm_idstringenvironmentstringoptionalNetsuite Credentials
consumer_keystringconsumer_secretstringtoken_idstringtoken_secretstringstore_namestringpublic_keystringPlaid Credentials
client_idstringsecretstringaccess_tokenstringenvironmentstringoptionalResponse Body
connectionobjectShow
connection attributesList Connections
GET /connectionsSupported for: All Platforms
Response Body
connectionsarrayShow
connections attributesFetch a Connection
GET /connections/access_tokenSupported for: AmazonBigCommerceChargebeeChargifyDynamics 365EbayEtsyFresh BooksLazadaMagentoMercado LibreNetSuitePayPalPrestaShopQuickBooksQuickBooks DesktopRecurlySage Business CloudSage IntacctShopeeShoperShopifyShopwareSquareSquarespaceStripeWalmartWaveWixWooCommerceXeroZoho Books
Request Parameters
access_tokenstringqueryThe access token of the connection.
Response Body
connectionobjectShow
connection attributesFetch a Connection Status
GET /connections/statusSupported for: All Platforms
Request Parameters
access_tokenstringqueryThe access token of the connection.
Response Body
statusobjectShow
status attributesconnectionobjectShow
connection attributesDelete a Connection
DELETE /connections/:idSupported for: All Platforms
Request Parameters
idstringpathThe Rutter connection ID to delete.
Response Body
successbooleantrue if the delete operation succeeded.
Example Response Body
{
"success": true
}