Tokens

The Tokens endpoints are used to obtain and manage tokens from Rutter Link. A public_token is returned whenever a merchant successfully shares their data with you through Rutter Link. However, the public_token cannot be used directly with our API. It must be exchanged for an access_token via the Exchange a Token endpoint described below.

Exchange a Token

POSThttps://production.rutterapi.com/versioned/item/public_token/exchange

Request Body

    client_idstringRequired

    Your Rutter API client_id.

    public_tokenstringRequired

    The public_token obtained from the Rutter Link onSuccess callback.

    secretstringRequired

    Your Rutter API secret.

Response Body

    connection_idstringRequired

    The Rutter generated unique ID of the connection.

    access_tokenstringRequired

    The access token associated with the Connection.

    is_readybooleanRequired

    A value determining whether all data is ready for a connection. See Connection Lifecycle for more details.

    platformenumRequired

    See our supporting Commerce Platforms or Accounting Platforms pages for the platform enumeration

    One ofAMAZONEBAYETSYFNACWALMARTSHOPEELAZADAMERCADOLIBREALIBABASHOPLINEPRESTASHOPSHOPIFYMAGENTOWOO_COMMERCESQUARESPACEWIXSHOPERSHOPLAZZABIG_COMMERCESHOPWARECOMMERCELAYERWEBFLOWGUMROADECWIDPAYPALSQUARESTRIPECLOVERMOLLIEPAYNLAUTHORIZENETRECHARGECHARGIFYCHARGEBEERECURLYKASHFLOWSAGE_INTACCTDYNAMICS365ZOHOBOOKSEXACTONLINEFREEAGENTQUICKBOOKSQUICKBOOKS_DESKTOPFRESHBOOKSXEROSAGE_BUSINESS_CLOUDSAGESAGE_50NETSUITEWAVEMONEYBIRDSAGE200CLOUDPLAIDODOOTALLYGOOGLEFACEBOOK, or TIKTOK.
    store_unique_namestring

    Unique store identifier.

Support by integration
All platforms
Example Response Body
JSON
1
{
2
"connection_id": "00000000-0000-0000-0000-000000000000",
3
"access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
4
"is_ready": true,
5
"platform": "SHOPIFY",
6
"store_unique_name": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op"
7
}

Have questions?

Contact support for personalized guidance.

Contact support