Sign Customiser

Navigation

Dark mode

Integrations

list_integrations

read

List integrations

Copy page

See how the Store is connected to its selling platforms, and obtain the integration ids get_integration and list_integration_activity_logs take.

Overview

Lists the commerce integrations connected to the connected Store, enabled or not, with each integration id, platform type, name, whether it is enabled, whether it accepts order and product writes, and its settings that are not credentials, such as a Shopify domain or a custom integration product URL. Tokens and secrets are never returned. It cannot connect, change or remove an integration. It requires the integrations:read scope and has no side effects.

Permission

Requires theintegrations:readpermission. A connection without it answersinsufficient_scopenaming the permission to approve.

Annotations

readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
openWorldHintfalse

Prerequisites

  • A merchant has connected this store and approved the integrations:read scope.

Arguments

limitinteger

How many integrations to return per page, between 1 and 100. Defaults to 20.

cursorstring

The opaque next_cursor value from the previous page.

Result

Up to `limit` integrations, oldest first, plus the cursor for the next page.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
integrationsarray of objectalways present

The page of integrations.

integrations[].idintegeralways present
integrations[].typestringalways present

Expected to grow.

One of: shopify, woocommerce, wix, etsy, custom

integrations[].namestringalways present
integrations[].enabledbooleanalways present
integrations[].accepts_writesbooleanalways present

True only for an enabled custom integration, the kind create_order and create_integration_product accept.

integrations[].settingsobjectalways present

The settings of the integration type, never its credentials, tokens or platform session ids. Each type carries only its own keys, and a key that is not set is null.

integrations[].settings.api_urlstring or null

woocommerce only: the address of the WooCommerce store, as its scheme, host, port and path only (no user name, password, path parameter, query string or fragment).

integrations[].settings.create_product_urlstring or null

custom only: the address Sign Customiser sends new products to, as its scheme, host, port and path only (no user name, password, path parameter, query string or fragment).

integrations[].settings.domainstring or null

shopify only: the myshopify.com domain of the Shopify store.

integrations[].settings.publication_idstring or null

shopify only: the Shopify publication new products are published to, or null for the default.

integrations[].settings.default_product_statusstring or null

shopify only: the status new products get on Shopify (closed).

One of: active, unlisted

integrations[].settings.versionstring or null

wix only: the Wix catalogue version (closed), or null before it is known.

One of: v1, v3

integrations[].settings.managed_bystring or null

etsy only: what manages the integration.

paginationobjectalways present
pagination.has_morebooleanalways present
pagination.next_cursorstring or null

Error cases

insufficient_scope

The connection was approved without integrations:read.

invalid_cursor

The cursor was altered or reused for a different collection or Store; restart with no cursor.

invalid_parameter

limit is not an integer from 1 to 100.

The Store integrations

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_integrations",
    "arguments": {}
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "integrations": [
        {
          "id": 31,
          "type": "shopify",
          "name": "Main store",
          "enabled": true,
          "accepts_writes": false,
          "settings": {
            "domain": "example.myshopify.com",
            "publication_id": null,
            "default_product_status": "active"
          }
        }
      ],
      "pagination": {
        "has_more": false,
        "next_cursor": null
      }
    }
  }
}

A connection without integrations:read (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_integrations",
    "arguments": {}
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "insufficient_scope",
        "title": "Insufficient scope",
        "detail": "The tool [list_integrations] requires the integrations:read scope, which this connection was not granted.",
        "recovery": "The connection was authorised without the scope this tool needs. Ask the merchant to reconnect the Sign Customiser connector and approve the scope named in required_scopes. If the approval screen does not offer that permission, ask them to remove the connector from this AI agent and add it again. Do not retry this call.",
        "required_scopes": [
          "integrations:read"
        ],
        "granted_scopes": [
          "store:read"
        ]
      }
    }
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.