SHOPLINE MCP (Model Context Protocol)

⚠️
By using the SHOPLINE MCP, you agree to the SHOPLINE API Terms.

MCP Features

The Model Context Protocol (MCP) is an open standard that enables AI applications to securely connect with external data sources and tools. By integrating the SHOPLINE MCP, you empower your AI agents with:

Built-in Knowledge Base: Instantly search and fetch both SHOPLINE Open API schemas, documentation and FAQs to resolve integration queries.
Secure Data Retrieval: Securely interact with SHOPLINE Open API endpoints to read real-time data.
Accelerated Code Generation: Leverage the AI's deep understanding of SHOPLINE's data structures to auto-generate accurate payloads and integration scripts.

MCP Tools

The SHOPLINE MCP exposes the following MCP tools. We recommend enabling human confirmation of tools and exercising caution when using the SHOPLINE MCP with other servers to avoid prompt injection attacks.

MCP Tools	Description	API Endpoints
`shopline_get_orders`	Retrieve store order lists and transaction history.	Get Orders
`shopline_get_customers`	Fetch customer profiles and membership data.	Get Customers
`shopline_get_products`	Query the store's product catalog and item details.	Get Products
`shopline_get_products_stocks`	Check real-time inventory levels for specific products.	Get Product Stocks
`shopline_get_promotions`	Fetch active discounts, free shipping rules, and promotional campaigns.	Get Promotions
`shopline_get_user_coupons`	Fetch customers who have received coupons from a specific promotion.	Get User Coupons With Cursor
`shopline_create_user_coupon`	Create and assign a coupon to a specific customer.	Send Coupon
`shopline_add_customer_tags`	Add tags to an existing customer profile.	Add Customer tags
`shopline_create_promotions`	Create draft discounts, coupon campaigns, and free shipping promotions.	Create Promotion
`shopline_list_admin_open_api_endpoints`	Discover all available SHOPLINE Open API endpoints.	All Admin APIs
`shopline_get_admin_open_api_endpoint`	Retrieve detailed request and response schemas for a specific API endpoint.	All Admin APIs
`shopline_list_admin_open_api_docs`	Browse the index of all SHOPLINE Open API documentations.	Knowledge Base
`shopline_fetch_admin_open_api_doc`	Fetch the complete content of a specific Open API document.	Knowledge Base
`shopline_list_developer_docs`	Retrieve a directory of general SHOPLINE Developer documentation.	Knowledge Base
`shopline_fetch_developer_doc`	Access the full text of a specific developer guide.	Knowledge Base
`shopline_search_faqs`	Search SHOPLINE's official FAQ articles using keywords.	Knowledge Base
`shopline_fetch_faq`	Retrieve the full, step-by-step content of a specific FAQ article.	Knowledge Base
`switch_shop`	Switch to a different merchant shop and reset the current MCP session. Re-authentication is required after switching.	N/A

MCP Prompts (Guided Workflows)

MCP Prompts act as built-in standard operating procedures (SOPs). They teach your AI agent how to efficiently combine multiple tools to achieve complex goals without manual instruction.

MCP Prompts	Description	Guided Workflow
`shopline_search_admin_open_api_docs`	Intelligent search for Open API documentation.	Teaches the Agent to combine `shopline_list_admin_open_api_docs` with `shopline_fetch_admin_open_api_doc` for schema context.
`shopline_search_developer_docs`	Exploration of developer guides.	Instructs the Agent to use `shopline_list_developer_docs` and `shopline_fetch_developer_doc` for tutorials.

Connect to SHOPLINE MCP

Before configuring this MCP, please make sure Node.js is installed on your machine.

Open Claude Desktop → Settings → Connectors → Add Custom Connector → Enter the server URL:

https://shopline-open.shopline.io/mcp/on-demand

📘
Security Guidelines
You are strictly responsible for all actions performed via MCP on your store. To protect your store data, follow these best practices:

Enable MCP Access: Navigate to Admin → Settings → Permission & Security → Staff Members → API Auth and turn on MCP Access for the staff account that will use MCP.

Apply Least Privilege: On the same page, select the permissions to grant MCP access. Note that AI can only access permissions that are both checked and currently supported by MCP — do not check permissions you do not want your AI to access.

⚠️ Beware of Prompt Injection: Processing unverified external content or connecting to untrusted servers may allow attackers to embed hidden instructions, tricking your AI into executing unauthorized SHOPLINE tools. Ensure your AI interacts only with trusted sources.

Testing Your MCP Setup

To test your connection, open a new chat in your AI client (e.g., Claude Desktop, Cursor) and try questions like:

- "Fetch the details for [order number] and tell me its status."
- "Check the current inventory stock for the [product name]."
- "How do I manage [specific resource] via the Open API?"
- "Show me a request payload example for [specific API / webhook]."
- "What are SHOPLINE's rules and procedures for [specific features]?"
- "How do I configure [specific store setting] in the SHOPLINE admin?"

The AI should now have access to your real-time SHOPLINE store data and official documentation through the MCP.