Rutter

Rutter Store API

The Store API from Rutter — 1 operation(s) for store.

Documentation GitHub OpenAPI

Operations 1

GET /store List commerce stores #

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-store-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

openapi: 3.2.0
info:
  title: Rutter Store 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: Store
paths:
  /store:
    get:
      summary: List commerce stores
      operationId: listCommerceStores
      parameters:
      - name: access_token
        in: query
        required: true
        description: The access token of the connection.
        schema:
          $ref: '#/components/schemas/GetStoreQueryParams/properties/access_token'
      - name: expand
        in: query
        required: false
        description: Include platform specific data (includes additional fields not provided by the Rutter object).
        schema:
          $ref: '#/components/schemas/GetStoreQueryParams/properties/expand'
      - name: show_seller_performance
        in: query
        required: false
        description: Amazon only. When `true`, fetches the latest GET_V2_SELLER_PERFORMANCE_REPORT and includes the raw payload at `store.platform_data.sellerPerformance`. Requires `expand=platform_data`.
        schema:
          $ref: '#/components/schemas/GetStoreQueryParams/properties/show_seller_performance'
      - name: force_fetch
        in: query
        required: false
        description: Used to force a response even if the underlying connection has not finished its initial sync.
        schema:
          $ref: '#/components/schemas/GetStoreQueryParams/properties/force_fetch'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStoreResponse'
              examples:
                GetStoreResponse_Example:
                  $ref: '#/components/examples/GetStoreResponse_Example'
      x-supported-platforms:
      - AMAZON
      - BIG_COMMERCE
      - EBAY
      - ETSY
      - LAZADA
      - MAGENTO
      - MERCADOLIBRE
      - NOON
      - PRESTASHOP
      - SALLA
      - SHEIN
      - SHOPIFY
      - SHOPLAZZA
      - SHOPLINE
      - SQUARE
      - SQUARESPACE
      - STRIPE
      - TIKTOKSHOP
      - WALMART
      - WAYFAIR
      - WIX
      - WOO_COMMERCE
      - ZID
      x-sandbox-supported-platforms: []
      tags:
      - Store
      x-summary-source: derived
components:
  examples:
    GetStoreResponse_Example:
      value:
        store:
          id: 00000000-0000-0000-0000-000000000000
          store_name: The Rutter Store
          url: https://www.rutter.com
          default_currency: USD
          email: eric@rutter.com
          locales:
            enabled:
            - en-US
            - pt-BR
            primary: en-US
          platform_data:
            id: 123
            data: Varies by platform
        connection:
          id: 00000000-0000-0000-0000-000000000000
          orgId: 00000000-0000-0000-0000-000000000000
          platform: SHOPIFY
    Store_Example:
      value:
        id: 00000000-0000-0000-0000-000000000000
        store_name: The Rutter Store
        url: https://www.rutter.com
        default_currency: USD
        email: eric@rutter.com
        locales:
          enabled:
          - en-US
          - pt-BR
          primary: en-US
        platform_data:
          id: 123
          data: Varies by platform
    Connection_Example:
      value:
        id: 00000000-0000-0000-0000-000000000000
        orgId: 00000000-0000-0000-0000-000000000000
        platform: SHOPIFY
  schemas:
    GetStoreResponse:
      type: object
      properties:
        store:
          $ref: '#/components/schemas/Store'
          type:
          - 'null'
        connection:
          $ref: '#/components/schemas/Connection'
      required:
      - store
      examples:
      - GetStoreResponse_Example:
          $ref: '#/components/examples/GetStoreResponse_Example'
    GetStoreQueryParams:
      type: object
      properties:
        access_token:
          type: string
          format: uuid
          description: The access token of the connection.
        expand:
          type: array
          items:
            type: string
            enum:
            - platform_data
          description: Include platform specific data (includes additional fields not provided by the Rutter object).
        show_seller_performance:
          type: string
          enum:
          - 'true'
          - 'false'
          description: Amazon only. When `true`, fetches the latest GET_V2_SELLER_PERFORMANCE_REPORT and includes the raw payload at `store.platform_data.sellerPerformance`. Requires `expand=platform_data`.
        force_fetch:
          type: string
          enum:
          - 'true'
          - 'false'
          description: Used to force a response even if the underlying connection has not finished its initial sync.
      required:
      - access_token
    Connection:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The UUID of the connection. Generated by Rutter.
        orgId:
          type: string
          format: uuid
          description: Your organization id.
        platform:
          $ref: '#/components/schemas/Platform'
      required:
      - id
      - orgId
      - platform
      examples:
      - Connection_Example:
          $ref: '#/components/examples/Connection_Example'
    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: The underlying platform.
    Store:
      type: object
      properties:
        id:
          type: string
          description: The Rutter generated unique ID of the store.
          x-rutter-platforms:
            AMAZON: {}
            BIG_COMMERCE: {}
            NOON: {}
            SALLA: {}
            SHEIN: {}
            SHOPIFY: {}
            SHOPLINE: {}
            STRIPE: {}
            TIKTOKSHOP: {}
            WALMART: {}
            WAYFAIR: {}
            ZID: {}
        platform_id:
          type: string
          description: The platform's unique identifier for the store. Supported for Amazon and Shopify.
          x-rutter-platforms:
            AMAZON: {}
            NOON: {}
            SHEIN: {}
            SHOPIFY: {}
            TIKTOKSHOP: {}
            WAYFAIR: {}
        store_name:
          type: string
          description: The unique identifier or brand name of the store.
          x-rutter-platforms:
            AMAZON: {}
            BIG_COMMERCE: {}
            NOON: {}
            SALLA: {}
            SHOPIFY: {}
            SHOPLINE: {}
            STRIPE: {}
            TIKTOKSHOP: {}
            WALMART: {}
            WAYFAIR: {}
            ZID: {}
        url:
          type: string
          description: The consumer facing URL of the store.
          x-rutter-platforms:
            AMAZON: {}
            BIG_COMMERCE: {}
            SALLA: {}
            SHOPIFY: {}
            SHOPLINE: {}
            STRIPE: {}
            WALMART: {}
            WAYFAIR: {}
            ZID: {}
        default_currency:
          type:
          - string
          - 'null'
          description: The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the store.
          x-rutter-platforms:
            AMAZON: {}
            BIG_COMMERCE: {}
            SALLA: {}
            SHOPIFY: {}
            SHOPLINE: {}
            STRIPE: {}
            ZID: {}
        email:
          type: string
          description: The email of the primary contact of the store.
          x-rutter-platforms:
            BIG_COMMERCE: {}
            SALLA: {}
            SHOPIFY: {}
            SHOPLINE: {}
            STRIPE: {}
            ZID: {}
        locales:
          type: object
          properties:
            enabled:
              type: array
              items:
                type: string
              description: Every locale enabled on the store, including the primary one.
              x-rutter-platforms:
                SHOPIFY: {}
            primary:
              type:
              - string
              - 'null'
              description: The primary locale of the store, for example `en-US` or `pt-BR`.
              x-rutter-platforms:
                SHOPIFY: {}
          required:
          - enabled
          - primary
          additionalProperties: false
          description: The locales configured on the store. Supported for Shopify.
          x-rutter-platforms:
            SHOPIFY: {}
        platform_data:
          type: object
          additionalProperties: {}
          description: The raw platform data corresponding to the Rutter object.
      required:
      - id
      - store_name
      - url
      - default_currency
      examples:
      - Store_Example:
          $ref: '#/components/examples/Store_Example'

Rutter Store API

Operations 1

Documentation

Specifications

Schemas & Data

Other Resources