Integrations
get_integration
readGet integration
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
Prerequisites
- An integration id from list_integrations or get_store.
- A merchant has connected this store and approved the integrations:read scope.
Arguments
The integration id, from list_integrations.
Result
The integration with its type-specific settings.
The integration.
Expected to grow.
One of: shopify, woocommerce, wix, etsy, custom
True only for an enabled custom integration, the kind create_order and create_integration_product accept.
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.
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).
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).
shopify only: the myshopify.com domain of the Shopify store.
shopify only: the Shopify publication new products are published to, or null for the default.
shopify only: the status new products get on Shopify (closed).
One of: active, unlisted
wix only: the Wix catalogue version (closed), or null before it is known.
One of: v1, v3
etsy only: what manages the integration.
Error cases
The connection was approved without integrations:read.
No integration with that id belongs to this store. Call list_integrations to find a valid id.
Read a custom integration
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_integration",
"arguments": {
"integration_id": 32
}
}
}{
"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)
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_integration",
"arguments": {
"integration_id": 999
}
}
}{
"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."
}
}
}
}