Rutter

Rutter Item API

The Item API from Rutter — 1 operation(s) for item.

GitHub OpenAPI

Operations 1

POST /item/public_token/exchange Exchange token #

Documentation

📖
Documentation
https://docs.rutter.com/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rutter/openapi/rutter-item-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-list-transactions-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-balance-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-list-subscriptions-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-list-payouts-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-transactions-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-payouts-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-webhook-config-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-list-webhook-logs-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-webhook-log-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-request-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-get-json-path-config-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/rutter/json-schema/rutter-update-json-path-config-response-schema.json

Other Resources

🔗
ProductPage
https://www.rutter.com/product/payments-api

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/rutter:rutter-item-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

rutter-item-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rutter Item API
  version: '2024-08-31'
  description: The Universal API for all major e-commerce platforms, accounting systems, and payment processors.
servers:
- url: https://production.rutterapi.com/versioned
  description: Production server
- url: https://sandbox.rutterapi.com/versioned
  description: Sandbox server
tags:
- name: Item
paths:
  /item/public_token/exchange:
    post:
      summary: Exchange token
      operationId: exchangeToken
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExchangeTokenBody'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExchangeTokenResponse'
              examples:
                ExchangeTokenResponse_Example:
                  $ref: '#/components/examples/ExchangeTokenResponse_Example'
      x-supported-platforms:
      - '*'
      x-sandbox-supported-platforms: []
      tags:
      - Item
      x-summary-source: derived
components:
  examples:
    ExchangeTokenResponse_Example:
      value:
        connection_id: 00000000-0000-0000-0000-000000000000
        access_token: access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6
        is_ready: true
        platform: SHOPIFY
        name: My Shopify Store
        store_unique_name: M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op
  schemas:
    ExchangeTokenBody:
      type: object
      properties:
        client_id:
          type: string
          description: Your Rutter API `client_id`.
        public_token:
          type: string
          description: The `public_token` obtained from the Rutter Link `onSuccess` callback.
        secret:
          type: string
          description: Your Rutter API `secret`.
      required:
      - client_id
      - public_token
      - secret
    ExchangeTokenResponse:
      type: object
      properties:
        connection_id:
          type: string
          description: The Rutter generated unique ID of the connection.
        access_token:
          type: string
          description: The access token associated with the Connection.
        is_ready:
          type: boolean
          description: A value determining whether all data is ready for a connection. See Connection Lifecycle for more details.
        platform:
          type: string
          enum:
          - AMAZON
          - EBAY
          - ETSY
          - FNAC
          - WALMART
          - SHOPEE
          - LAZADA
          - MERCADOLIBRE
          - ALIBABA
          - WAYFAIR
          - SHEIN
          - NOON
          - SHOPLINE
          - PRESTASHOP
          - SHOPIFY
          - MAGENTO
          - WOO_COMMERCE
          - SQUARESPACE
          - WIX
          - SHOPER
          - SHOPLAZZA
          - BIG_COMMERCE
          - SALLA
          - ZID
          - TIKTOKSHOP
          - COMMERCELAYER
          - WEBFLOW
          - GUMROAD
          - ECWID
          - PAYPAL
          - SQUARE
          - STRIPE
          - CLOVER
          - MOLLIE
          - PAYNL
          - AUTHORIZENET
          - RECHARGE
          - CHARGIFY
          - CHARGEBEE
          - RECURLY
          - KASHFLOW
          - SAGE_INTACCT
          - SAGE_INTACCT_V2
          - DYNAMICS365
          - DYNAMICS365FO
          - ZOHOBOOKS
          - EXACTONLINE
          - FREEAGENT
          - QUICKBOOKS
          - QUICKBOOKS_DESKTOP
          - FRESHBOOKS
          - XERO
          - SAGE_BUSINESS_CLOUD
          - SAGE_50
          - VISTA
          - NETSUITE
          - WAVE
          - DUALENTRY
          - CAMPFIRE
          - RILLET
          - SOFTLEDGER
          - VISMA
          - SPIRIS
          - LEXWARE
          - MONEYBIRD
          - SAGE200CLOUD
          - MX
          - PLAID
          - TELLER
          - RAMP
          - ODOO
          - ACUMATICA
          - FULFIL
          - TALLY
          - SAPBUSINESSONE
          - SAPS4HANA
          - WORKDAY
          - ANFIX
          - ORACLEFUSION
          - HOLDED
          - MYOBBUSINESS
          - FORTNOX
          - GOOGLE
          - FACEBOOK
          - TIKTOK
          - INTUIT_BANK_FEEDS
          - PLAID_BANK_FEEDS
          - SAGE
          - SAGE_BANK_FEEDS
          - YODLEE_BANK_FEEDS
          - QUICKBOOKS_HRIS
          - BAMBOO_HR
          - GUSTO
          - DEEL
          - RIPPLING
          description: See our supporting Commerce Platforms or Accounting Platforms pages for the platform enumeration
        name:
          type:
          - string
          - 'null'
          description: The name of the connection as displayed in the Rutter dashboard.
        store_unique_name:
          type: string
          description: Unique store identifier.
      required:
      - connection_id
      - access_token
      - is_ready
      - platform
      - name
      examples:
      - ExchangeTokenResponse_Example:
          $ref: '#/components/examples/ExchangeTokenResponse_Example'