Sign Customiser

Navigation

Dark mode

Check how one integration is set up, for example which address a custom integration sends new products to.

Overview

Reads one commerce integration of the connected Store: its id, platform type, name, whether it is enabled, whether it accepts order and product writes, and its settings that are not credentials. Tokens and secrets are never returned. It cannot change the 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

  • An integration id from list_integrations or get_store.
  • A merchant has connected this store and approved the integrations:read scope.

Arguments

integration_idintegerrequired

The integration id, from list_integrations.

Result

The integration with its type-specific settings.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
integrationobjectalways present

The integration.

integration.idintegeralways present
integration.typestringalways present

Expected to grow.

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

integration.namestringalways present
integration.enabledbooleanalways present
integration.accepts_writesbooleanalways present

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

integration.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.

integration.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).

integration.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).

integration.settings.domainstring or null

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

integration.settings.publication_idstring or null

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

integration.settings.default_product_statusstring or null

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

One of: active, unlisted

integration.settings.versionstring or null

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

One of: v1, v3

integration.settings.managed_bystring or null

etsy only: what manages the integration.

Error cases

insufficient_scope

The connection was approved without integrations:read.

resource_not_found

No integration with that id belongs to this store. Call list_integrations to find a valid id.

Read a custom integration

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_integration",
    "arguments": {
      "integration_id": 32
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "integration": {
        "id": 32,
        "type": "custom",
        "name": "Workshop system",
        "enabled": true,
        "accepts_writes": true,
        "settings": {
          "create_product_url": "https://workshop.example.com/sign-customiser/products"
        }
      }
    }
  }
}

An integration of another store (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_integration",
    "arguments": {
      "integration_id": 999
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "resource_not_found",
        "title": "Resource not found",
        "detail": "The requested resource does not exist or does not belong to the authenticated store.",
        "recovery": "The identifier does not exist in this store. Use the matching list tool to rediscover a valid id."
      }
    }
  }
}

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