@synap-core/workspace-templates 0.12.0 → 0.24.0

package/capabilities/shopify.capability.json

@@ -0,0 +1,395 @@
+{
+  "apiVersion": "synap/v1",
+  "kind": "capability",
+  "meta": {
+    "slug": "shopify",
+    "name": "Shopify — Store Operations",
+    "description": "Read-only access to your Shopify store: list and get products, orders, customers and inventory levels through a Nango OAuth connection. Connect your Shopify store in Settings → Connectors.",
+    "tags": [
+      "capability",
+      "ecommerce"
+    ],
+    "isPublic": true,
+    "syncByDefault": true
+  },
+  "spec": {
+    "key": "shopify",
+    "name": "Shopify — Store Operations",
+    "description": "Read-only Shopify Admin API access through one Nango OAuth connection. Lists and retrieves products, orders and customers, and lists inventory levels. This capability deliberately contains no product, order, customer or inventory writes. PRECONDITION: the 'shopify' integration must be declared and configured in the pod's Nango, and the acting user must connect a Shopify store through Connectors. Shopify's OAuth scopes must include read_products, read_orders, read_customers and read_inventory. Paths are relative to the connected store's Shopify Admin API base URL and use the pinned REST version 2026-07. Every request sends X-Shopify-Access-Token through Nango. Shopify's REST Admin API is legacy for new public apps; this read-heavy pack is intended for an existing/private Shopify OAuth integration and should be migrated to GraphQL when the Nango connection exposes Shopify GraphQL routing.",
+    "params": [],
+    "vault": [],
+    "tools": [
+      {
+        "name": "shopify",
+        "kind": "provider",
+        "description": "Shopify Admin API access through Nango. credentialRef nango://shopify resolves the user's connected Shopify store and proxies requests to that store's Admin API base URL. The Nango Shopify integration supplies the OAuth access token and sends it as X-Shopify-Access-Token.",
+        "credentialRef": "nango://shopify",
+        "executor": "is-agent",
+        "config": {
+          "providerConfigKey": "shopify"
+        }
+      }
+    ],
+    "skills": [
+      {
+        "name": "shopify_list_products",
+        "intent": "list_records",
+        "kind": "declarative",
+        "scope": "pod",
+        "description": "Lists products in the connected Shopify store, newest first. Args: { limit?: number (default 50, max 250), pageInfo?: string (cursor from a prior response).",
+        "requires": [
+          "shopify"
+        ],
+        "executionMode": "sync",
+        "timeoutSeconds": 60,
+        "parameters": {
+          "limit": "number?",
+          "pageInfo": "string?"
+        },
+        "providerSpec": {
+          "tool": "shopify",
+          "method": "GET",
+          "pathTemplate": "/admin/api/2026-07/products.json",
+          "query": {
+            "limit": "{{limit}}",
+            "page_info": "{{pageInfo}}"
+          },
+          "paramMapping": {
+            "limit": {
+              "default": 50,
+              "clampMin": 1,
+              "clampMax": 250
+            },
+            "pageInfo": {
+              "encode": "uri"
+            }
+          },
+          "responseShape": {
+            "collectionPath": "products",
+            "collectionAs": "products",
+            "item": {
+              "id": "id",
+              "title": "title",
+              "handle": "handle",
+              "status": "status",
+              "vendor": "vendor",
+              "productType": "product_type",
+              "createdAt": "created_at",
+              "updatedAt": "updated_at",
+              "variants": "variants",
+              "images": "images"
+            },
+            "scalar": {
+              "count": "@count"
+            }
+          }
+        }
+      },
+      {
+        "name": "shopify_get_product",
+        "intent": "fetch_record",
+        "kind": "declarative",
+        "scope": "pod",
+        "description": "Gets one Shopify product by numeric product id. Args: { productId: string }.",
+        "requires": [
+          "shopify"
+        ],
+        "executionMode": "sync",
+        "timeoutSeconds": 60,
+        "parameters": {
+          "productId": "string"
+        },
+        "providerSpec": {
+          "tool": "shopify",
+          "method": "GET",
+          "pathTemplate": "/admin/api/2026-07/products/{{productId}}.json",
+          "paramMapping": {
+            "productId": {
+              "required": true,
+              "encode": "uri"
+            }
+          },
+          "responseShape": {
+            "scalar": {
+              "id": "product.id",
+              "title": "product.title",
+              "handle": "product.handle",
+              "status": "product.status",
+              "vendor": "product.vendor",
+              "productType": "product.product_type",
+              "createdAt": "product.created_at",
+              "updatedAt": "product.updated_at",
+              "variants": "product.variants",
+              "images": "product.images"
+            }
+          }
+        }
+      },
+      {
+        "name": "shopify_list_orders",
+        "intent": "list_records",
+        "kind": "declarative",
+        "scope": "pod",
+        "description": "Lists orders in the connected Shopify store, newest first. Defaults to orders of any status. Args: { limit?: number (default 50, max 250), status?: string, pageInfo?: string (cursor from a prior response).",
+        "requires": [
+          "shopify"
+        ],
+        "executionMode": "sync",
+        "timeoutSeconds": 60,
+        "parameters": {
+          "limit": "number?",
+          "status": "string?",
+          "pageInfo": "string?"
+        },
+        "providerSpec": {
+          "tool": "shopify",
+          "method": "GET",
+          "pathTemplate": "/admin/api/2026-07/orders.json",
+          "query": {
+            "limit": "{{limit}}",
+            "status": "{{status}}",
+            "page_info": "{{pageInfo}}"
+          },
+          "paramMapping": {
+            "limit": {
+              "default": 50,
+              "clampMin": 1,
+              "clampMax": 250
+            },
+            "status": {
+              "default": "any"
+            },
+            "pageInfo": {
+              "encode": "uri"
+            }
+          },
+          "responseShape": {
+            "collectionPath": "orders",
+            "collectionAs": "orders",
+            "item": {
+              "id": "id",
+              "name": "name",
+              "email": "email",
+              "financialStatus": "financial_status",
+              "fulfillmentStatus": "fulfillment_status",
+              "totalPrice": "total_price",
+              "currency": "currency",
+              "customer": "customer",
+              "lineItems": "line_items",
+              "createdAt": "created_at",
+              "updatedAt": "updated_at",
+              "cancelledAt": "cancelled_at"
+            },
+            "scalar": {
+              "count": "@count"
+            }
+          }
+        }
+      },
+      {
+        "name": "shopify_get_order",
+        "intent": "fetch_record",
+        "kind": "declarative",
+        "scope": "pod",
+        "description": "Gets one Shopify order by numeric order id. Args: { orderId: string }.",
+        "requires": [
+          "shopify"
+        ],
+        "executionMode": "sync",
+        "timeoutSeconds": 60,
+        "parameters": {
+          "orderId": "string"
+        },
+        "providerSpec": {
+          "tool": "shopify",
+          "method": "GET",
+          "pathTemplate": "/admin/api/2026-07/orders/{{orderId}}.json",
+          "paramMapping": {
+            "orderId": {
+              "required": true,
+              "encode": "uri"
+            }
+          },
+          "responseShape": {
+            "scalar": {
+              "id": "order.id",
+              "name": "order.name",
+              "email": "order.email",
+              "financialStatus": "order.financial_status",
+              "fulfillmentStatus": "order.fulfillment_status",
+              "totalPrice": "order.total_price",
+              "currency": "order.currency",
+              "customer": "order.customer",
+              "lineItems": "order.line_items",
+              "createdAt": "order.created_at",
+              "updatedAt": "order.updated_at",
+              "cancelledAt": "order.cancelled_at"
+            }
+          }
+        }
+      },
+      {
+        "name": "shopify_list_customers",
+        "intent": "list_records",
+        "kind": "declarative",
+        "scope": "pod",
+        "description": "Lists customers in the connected Shopify store, newest first. Args: { limit?: number (default 50, max 250), pageInfo?: string (cursor from a prior response).",
+        "requires": [
+          "shopify"
+        ],
+        "executionMode": "sync",
+        "timeoutSeconds": 60,
+        "parameters": {
+          "limit": "number?",
+          "pageInfo": "string?"
+        },
+        "providerSpec": {
+          "tool": "shopify",
+          "method": "GET",
+          "pathTemplate": "/admin/api/2026-07/customers.json",
+          "query": {
+            "limit": "{{limit}}",
+            "page_info": "{{pageInfo}}"
+          },
+          "paramMapping": {
+            "limit": {
+              "default": 50,
+              "clampMin": 1,
+              "clampMax": 250
+            },
+            "pageInfo": {
+              "encode": "uri"
+            }
+          },
+          "responseShape": {
+            "collectionPath": "customers",
+            "collectionAs": "customers",
+            "item": {
+              "id": "id",
+              "firstName": "first_name",
+              "lastName": "last_name",
+              "email": "email",
+              "phone": "phone",
+              "ordersCount": "orders_count",
+              "totalSpent": "total_spent",
+              "state": "state",
+              "tags": "tags",
+              "defaultAddress": "default_address",
+              "createdAt": "created_at",
+              "updatedAt": "updated_at"
+            },
+            "scalar": {
+              "count": "@count"
+            }
+          }
+        }
+      },
+      {
+        "name": "shopify_get_customer",
+        "intent": "fetch_record",
+        "kind": "declarative",
+        "scope": "pod",
+        "description": "Gets one Shopify customer by numeric customer id. Args: { customerId: string }.",
+        "requires": [
+          "shopify"
+        ],
+        "executionMode": "sync",
+        "timeoutSeconds": 60,
+        "parameters": {
+          "customerId": "string"
+        },
+        "providerSpec": {
+          "tool": "shopify",
+          "method": "GET",
+          "pathTemplate": "/admin/api/2026-07/customers/{{customerId}}.json",
+          "paramMapping": {
+            "customerId": {
+              "required": true,
+              "encode": "uri"
+            }
+          },
+          "responseShape": {
+            "scalar": {
+              "id": "customer.id",
+              "firstName": "customer.first_name",
+              "lastName": "customer.last_name",
+              "email": "customer.email",
+              "phone": "customer.phone",
+              "ordersCount": "customer.orders_count",
+              "totalSpent": "customer.total_spent",
+              "state": "customer.state",
+              "tags": "customer.tags",
+              "defaultAddress": "customer.default_address",
+              "createdAt": "customer.created_at",
+              "updatedAt": "customer.updated_at"
+            }
+          }
+        }
+      },
+      {
+        "name": "shopify_list_inventory_levels",
+        "intent": "list_records",
+        "kind": "declarative",
+        "scope": "pod",
+        "description": "Lists Shopify inventory levels for inventory items and/or locations. At least one of inventoryItemIds or locationIds is required by Shopify. Args: { inventoryItemIds?: string, locationIds?: string, limit?: number (default 50, max 250), pageInfo?: string }.",
+        "requires": [
+          "shopify"
+        ],
+        "executionMode": "sync",
+        "timeoutSeconds": 60,
+        "parameters": {
+          "inventoryItemIds": "string?",
+          "locationIds": "string?",
+          "limit": "number?",
+          "pageInfo": "string?"
+        },
+        "providerSpec": {
+          "tool": "shopify",
+          "method": "GET",
+          "pathTemplate": "/admin/api/2026-07/inventory_levels.json",
+          "query": {
+            "inventory_item_ids": "{{inventoryItemIds}}",
+            "location_ids": "{{locationIds}}",
+            "limit": "{{limit}}",
+            "page_info": "{{pageInfo}}"
+          },
+          "paramMapping": {
+            "inventoryItemIds": {
+              "encode": "uri"
+            },
+            "locationIds": {
+              "encode": "uri"
+            },
+            "limit": {
+              "default": 50,
+              "clampMin": 1,
+              "clampMax": 250
+            },
+            "pageInfo": {
+              "encode": "uri"
+            }
+          },
+          "responseShape": {
+            "collectionPath": "inventory_levels",
+            "collectionAs": "inventoryLevels",
+            "item": {
+              "inventoryItemId": "inventory_item_id",
+              "locationId": "location_id",
+              "available": "available",
+              "updatedAt": "updated_at",
+              "adminGraphqlApiId": "admin_graphql_api_id"
+            },
+            "scalar": {
+              "count": "@count"
+            }
+          }
+        }
+      }
+    ],
+    "provides": [
+      "list_records",
+      "fetch_record"
+    ]
+  },
+  "dependencies": []
+}