Foundations

Connections

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

idstring

The UUID of the connection. Generated by Rutter.

platformPlatform

The underlying platform.

One ofSHOPERSHOPIFYSHOPWAREMAGENTOBIG_COMMERCEWOO_COMMERCESQUARESPACEWIXSQUARECOMMERCELAYERAMAZONETSYEBAYPRESTASHOPWEBFLOWLAZADAFNACALIBABASHOPEEMERCADOLIBREGUMROADSHOPLAZZAWALMARTSTRIPEPAYPALQUICKBOOKSQUICKBOOKS_DESKTOPECWIDXEROFRESHBOOKSNETSUITESAGE_BUSINESS_CLOUDSAGE_INTACCTZOHOBOOKSWAVEDYNAMICS365CHARGIFYCHARGEBEERECURLY, or PLAID.
orgIdstring

Your organization id.

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

Create a Connection

POST /connections/create
Supported for: AmazonBigCommerceEbayFnacLazadaMagentoNetSuitePlaidPrestaShopQuickBooksShoperShopifySquareStripeWooCommerce

Request Body

    All of:

    platformPlatform

    The underlying platform.

    One ofSHOPERSHOPIFYSHOPWAREMAGENTOBIG_COMMERCEWOO_COMMERCESQUARESPACEWIXSQUARECOMMERCELAYERAMAZONETSYEBAYPRESTASHOPWEBFLOWLAZADAFNACALIBABASHOPEEMERCADOLIBREGUMROADSHOPLAZZAWALMARTSTRIPEPAYPALQUICKBOOKSQUICKBOOKS_DESKTOPECWIDXEROFRESHBOOKSNETSUITESAGE_BUSINESS_CLOUDSAGE_INTACCTZOHOBOOKSWAVEDYNAMICS365CHARGIFYCHARGEBEERECURLY, or PLAID.
    scopestringoptional

    Any of:

    BigCommerce Credentials

    oauth_access_tokenstring
    store_urlstring
    oauth_client_idstringoptional
    oauth_client_secretstringoptional

    Amazon Credentials

    oauth_client_idstring
    oauth_client_secretstring
    oauth_refresh_tokenstring
    amazon_access_key_idstring
    amazon_secret_access_keystring
    amazon_selling_partner_rolestring
    amazon_seller_regionenum
    One ofnaeu, or fe.

    Shopify Credentials

    Any of:

    Shopify Private Credentials

    basic_usernamestring
    basic_passwordstring
    store_urlstring

    Shopify Public Credentials

    oauth_client_idstring
    oauth_client_secretstring
    oauth_access_tokenstring
    store_urlstring

    PrestaShop Credentials

    store_urlstring
    api_keystring

    Shoper Credentials

    store_urlstring
    oauth_access_tokenstring
    oauth_refresh_tokenstring

    WooCommerce Credentials

    store_urlstring
    basic_usernamestring
    basic_passwordstring

    Magento Credentials

    store_urlstring
    basic_usernamestring
    basic_passwordstring

    Ebay Credentials

    oauth_client_idstring
    oauth_client_secretstring
    oauth_refresh_tokenstring

    Lazada Credentials

    oauth_client_idstring
    oauth_client_secretstring
    oauth_access_tokenstring
    oauth_refresh_tokenstring
    countrystring

    Fnac Credentials

    partner_idstring
    shop_idstring
    keystring

    Square Credentials

    oauth_client_idstring
    oauth_client_secretstring
    oauth_refresh_tokenstring

    Stripe Credentials

    oauth_access_tokenstring
    account_idstring

    Quickbooks Credentials

    oauth_client_idstring
    oauth_client_secretstring
    oauth_refresh_tokenstring
    realm_idstring
    environmentstringoptional

    Netsuite Credentials

    consumer_keystring
    consumer_secretstring
    token_idstring
    token_secretstring
    store_namestring
    public_keystring

    Plaid Credentials

    client_idstring
    secretstring
    access_tokenstring
    environmentstringoptional

Response Body

    connectionobject
    Show connection attributes

List Connections

GET /connections
Supported for: All Platforms

Response Body

    connectionsarray
    Show connections attributes

Fetch a Connection

GET /connections/access_token
Supported for: AmazonBigCommerceChargebeeChargifyDynamics 365EbayEtsyFresh BooksLazadaMagentoMercado LibreNetSuitePayPalPrestaShopQuickBooksQuickBooks DesktopRecurlySage Business CloudSage IntacctShopeeShoperShopifyShopwareSquareSquarespaceStripeWalmartWaveWixWooCommerceXeroZoho Books

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Response Body

    connectionobject
    Show connection attributes

Fetch a Connection Status

GET /connections/status
Supported for: All Platforms

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Response Body

    statusobject
    Show status attributes
    connectionobject
    Show connection attributes

Delete a Connection

DELETE /connections/:id
Supported for: All Platforms

Request Parameters

    idstringpath

    The Rutter connection ID to delete.

Response Body

    successboolean

    true if the delete operation succeeded.

Example Response Body
{
  "success": true
}