Shindig works with AI assistants on paid plans
This page is for Shopify merchants who want an AI assistant to work with their Shindig events, sales reports, and Help Center. It describes the MCP server and the REST API. The Free plan does not include API or MCP. Plus is $4.99 per month or $45 per year, and Plus50 is $24.95 per month or $224.55 per year. Each paid plan includes a 14-day free trial. API and MCP need Plus or Plus50.
Every assistant connects the same way
Shindig's MCP endpoint is Streamable HTTP. Send this header on every request. The value is the Company Config API key:
Authorization: Bearer <Company Config API key>In the Shopify admin, open Shindig, then Settings, then Company Config, then API & MCP Access. Company Config shows the URL and the API key. Rotate the key there if it may have been exposed. API and MCP need Plus or Plus50. The same key works for the REST API. REST API quickstart.
When the client connects, it receives Shindig's server instructions plus these resources: guide://shindig/agent, schema://shindig/save-event, and Help Center articles at help://shindig/... (the index is help://shindig/index).
The assistant can run these Shindig tools
One API key from Settings, Company Config, API & MCP Access authorizes both surfaces. The MCP server and the REST API expose the same operations.
- list_active_events: Lists events and the shopping, portal, and snapshot links. Active events only, unless you set includeInactive. Each row has an active flag.
- get_event_details: Returns one event's configuration, including the shopping password and private message. It does not return orders.
- save_event: Creates or updates an event with the same checks as the admin screen. On an update, fields you omit keep their current values.
- search_shop_products: Searches active Shopify products. The query must be at least 2 characters. The default page is 10 products and the maximum is 25. Use the cursor from a response to get the next page.
- deactivate_event: Deactivates an event so it leaves the active list.
- reactivate_event: Turns a deactivated event back on.
- get_event_total_sales: Returns net sales for one event. Omit both dates for lifetime totals, or send both dates for a range of at most 365 days.
- sales_summary_report: Sales by event for a date range of at most 365 days. Omit page to return every row.
- sales_detail_report: Order-level sales for a date range of at most 90 days. Omit page to return every row.
- paypal_payouts_report: PayPal payout rows for a date range of at most 90 days. It requires a plan with referral features.
- search_help: Searches the in-app Help Center.
- get_help_section: Returns one Help Center section by its id.
The MCP server also publishes named prompts: create_event_from_brief, attach_promoted_products, set_event_password, year_end_sales_summary, and run_sales_detail.
Interactive docs: /api/v1/docs. OpenAPI contract: /api/v1/openapi.json.
Dates are YYYYMMDD integers. Sales summary and event sales allow 365 days. Sales detail and PayPal payouts allow 90 days. On an update, fields you omit keep their current values. Pass an empty formItems or eventProducts list only when you mean to clear it. A shopping password requires a private message. Turning on the user portal requires a portal password. A missing or inactive discount code returns a warning, and the save still succeeds.
Pick the guide for your assistant
Claude, ChatGPT, Grok Bot, and Cursor all use this connection.
Read another Shindig guide
Claude is a trademark of Anthropic. ChatGPT is a trademark of OpenAI. Grok Bot and Cursor are trademarks of their respective owners. Shindig is not affiliated with, endorsed by, or sponsored by those companies. Works with means you connect your own account.