Square Online MCP server for AI agents
Let Claude, ChatGPT or your own agent read Square Online: 13 typed functions through one MCP server. No Square Online API key needed.
- Site
- square.site
- Functions
- 13
- Sign-in
- For account actions
- Works with
- MCP, HTTP, Node, Python
Connect
An MCP server for Square Online alone, with one tool per function. Paste it into Claude, ChatGPT, Cursor or any MCP client as a remote server.
https://api.bowmark.ai/mcp/site/square_onlineOne MCP server for Square Online and every other site Bowmark covers. Your agent looks up what it needs and calls it.
https://api.bowmark.ai/mcpSet it up in your clientBoth need a Bowmark API key. The quickstart gets you one and a first result in a few minutes. Functions that need a login use the person's own account: how sign-in works.
Functions
Open a function to see its arguments, what it returns and how to call it.
getDeliveryTimesReturns the earliest delivery time and delivery slots (each with its arrival window) at one location, where the store delivers; same window rules as…Arguments
Name Type Required sitestringYes locationIdstringFrom listLocations().Yes fromstringISO instant; default now.No tostringISO instant; default one day after from.No Returns
SquareOnlinePickupTimesinterface SquareOnlinePickupSlot { timeIso: string; label: string; prepMinutes: number | null; /** getDeliveryTimes only: the window the order arrives in. */ deliveryWindow?: { startIso: string; endIso: string } | null; } interface SquareOnlinePickupDate { date: string; label: string | null; /** null when the window was wider than one day and the site never inlined this date's slots. */ times: SquareOnlinePickupSlot[] | null; } interface SquareOnlinePickupTimes { site: string; locationId: string; outsideSchedulingWindow: boolean; earliest: SquareOnlinePickupSlot | null; dates: SquareOnlinePickupDate[]; warnings: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/getDeliveryTimesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.getDeliveryTimes({ site: "seiskitchen.square.site", locationId: "V6FVCSZHJZ9R3" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.getDeliveryTimes({ "site": "seiskitchen.square.site", "locationId": "V6FVCSZHJZ9R3" }))curl -X POST https://api.bowmark.ai/v1/sites/square_online/getDeliveryTimes \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"seiskitchen.square.site","locationId":"V6FVCSZHJZ9R3"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.getDeliveryTimes({ site: "seiskitchen.square.site", locationId: "V6FVCSZHJZ9R3" });getItemAvailabilitySays which menu items are in stock or sold out at one location, by item ids or for a whole category.Arguments
Name Type Required sitestringYes locationIdstringFrom listLocations().Yes itemIdsstring[]SiteProductId values off listMenuItems().No categoryIdstringFrom listCategories(), every item in that section.No atstringISO instant the order would be ready; default now.No Returns
SquareOnlineAvailabilityinterface SquareOnlineMethodAvailability { available: boolean; /** The site's own reason codes, e.g. "item.not_setup_for_delivery". */ reasons: string[]; } interface SquareOnlineItemAvailability { siteProductId: string; pickup: SquareOnlineMethodAvailability; delivery: SquareOnlineMethodAvailability; dineIn: SquareOnlineMethodAvailability; shipping: SquareOnlineMethodAvailability; } interface SquareOnlineAvailability { site: string; locationId: string; at: string; items: SquareOnlineItemAvailability[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/getItemAvailabilityCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.getItemAvailability({ site: "anashawarma.square.site", locationId: "9JKEQP002DRF5", itemIds: ["25"] });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.getItemAvailability({ "site": "anashawarma.square.site", "locationId": "9JKEQP002DRF5", "itemIds": ["25"] }))curl -X POST https://api.bowmark.ai/v1/sites/square_online/getItemAvailability \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site","locationId":"9JKEQP002DRF5","itemIds":["25"]}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.getItemAvailability({ site: "anashawarma.square.site", locationId: "9JKEQP002DRF5", itemIds: ["25"] });getLoyaltyProgramReturns a store's loyalty program: whether it is active, and each reward tier's points and discount.Arguments
Name Type Required sitestringA storefront URL ("https://anashawarma.square.site"), its host, or the bare name before .square.site.Yes Returns
SquareOnlineLoyaltyinterface SquareOnlineRewardTier { id: string; name: string; points: number | null; scope: string | null; discountType: string | null; percentageDiscount: number | null; /** Minor units (cents). */ fixedDiscountAmount: number | null; maxDiscountAmount: number | null; currency: string | null; } interface SquareOnlineLoyaltyProgram { id: string; /** false when the owner set one up but switched it off. */ active: boolean; status: string | null; rewardTiers: SquareOnlineRewardTier[]; } interface SquareOnlineLoyalty { site: string; programs: SquareOnlineLoyaltyProgram[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/getLoyaltyProgramCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.getLoyaltyProgram({ site: "anashawarma.square.site" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.getLoyaltyProgram({"site": "anashawarma.square.site"}))curl -X POST https://api.bowmark.ai/v1/sites/square_online/getLoyaltyProgram \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.getLoyaltyProgram({ site: "anashawarma.square.site" });getMenuItemReturns one menu item in full: its sellable variations (SKUs) with price, sold-out state, which fulfillment methods they support, and any…Arguments
Name Type Required sitestringYes itemIdstringFrom listMenuItems() or listCategories().Yes Returns
SquareOnlineMenuIteminterface SquareOnlineMenuItemVariation { id: string; name: string; price: number | null; priceFormatted: string | null; soldOut: boolean; fulfillment: { pickup: boolean; delivery: boolean; shipping: boolean; dineIn: boolean }; /** Empty on every store observed so far; kept honestly rather than invented. */ optionChoices: Array<Record<string, unknown>>; } interface SquareOnlineMenuItem { id: string; siteProductId: string | null; name: string; shortDescription: string | null; priceLow: number | null; priceHigh: number | null; priceFormatted: string | null; imageUrl: string | null; soldOut: boolean; visible: boolean; url: string; variations: SquareOnlineMenuItemVariation[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/getMenuItemCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.getMenuItem({ site: "anashawarma.square.site", itemId: "J3YXFL2YOFAEUCZJ4FFVWPJD" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.getMenuItem({ "site": "anashawarma.square.site", "itemId": "J3YXFL2YOFAEUCZJ4FFVWPJD" }))curl -X POST https://api.bowmark.ai/v1/sites/square_online/getMenuItem \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site","itemId":"J3YXFL2YOFAEUCZJ4FFVWPJD"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.getMenuItem({ site: "anashawarma.square.site", itemId: "J3YXFL2YOFAEUCZJ4FFVWPJD" });getMyAccountReturns the signed-in buyer's Square Online account: name, phone, email, saved addresses and preferences.Arguments
Name Type Required sitestringA storefront URL ("https://anashawarma.square.site"), its host, or the bare name before .square.site.Yes Returns
SquareOnlineAccountinterface SquareOnlineAccount { site: string; /** The buyer's customer id on this store. */ customerId: string; /** The site's own customer record, unchanged (name, phone, email, addresses, preferences). */ customer: Record<string, unknown>; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/getMyAccountCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.getMyAccount({ site: "anashawarma.square.site" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.getMyAccount({"site": "anashawarma.square.site"}))curl -X POST https://api.bowmark.ai/v1/sites/square_online/getMyAccount \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.getMyAccount({ site: "anashawarma.square.site" });getPickupTimesReturns the earliest pickup time and the available pickup slots at one location over a date range (default: the next 24 hours).Arguments
Name Type Required sitestringYes locationIdstringFrom listLocations().Yes fromstringISO instant; default now.No tostringISO instant; default one day after from.No Returns
SquareOnlinePickupTimesinterface SquareOnlinePickupSlot { timeIso: string; label: string; prepMinutes: number | null; /** getDeliveryTimes only: the window the order arrives in. */ deliveryWindow?: { startIso: string; endIso: string } | null; } interface SquareOnlinePickupDate { date: string; label: string | null; /** null when the window was wider than one day and the site never inlined this date's slots. */ times: SquareOnlinePickupSlot[] | null; } interface SquareOnlinePickupTimes { site: string; locationId: string; outsideSchedulingWindow: boolean; earliest: SquareOnlinePickupSlot | null; dates: SquareOnlinePickupDate[]; warnings: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/getPickupTimesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.getPickupTimes({ site: "anashawarma.square.site", locationId: "9JKEQP002DRF5" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.getPickupTimes({ "site": "anashawarma.square.site", "locationId": "9JKEQP002DRF5" }))curl -X POST https://api.bowmark.ai/v1/sites/square_online/getPickupTimes \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site","locationId":"9JKEQP002DRF5"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.getPickupTimes({ site: "anashawarma.square.site", locationId: "9JKEQP002DRF5" });getSiteResolves a Square Online storefront from a URL the caller has (<name>.square.site or the restaurant's own domain) to its ids.Arguments
Name Type Required sitestringA storefront URL ("https://anashawarma.square.site"), its host, or the bare name before .square.site.Yes Returns
SquareOnlineSiteInfointerface SquareOnlineSiteInfo { /** The storefront origin every other function accepts as `site`. */ url: string; name: string | null; userId: string; siteId: string; /** The Square merchant id (the loyalty and subscription APIs key on it). */ merchantId: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/getSiteCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.getSite({ site: "anashawarma.square.site" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.getSite({"site": "anashawarma.square.site"}))curl -X POST https://api.bowmark.ai/v1/sites/square_online/getSite \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.getSite({ site: "anashawarma.square.site" });listCategoriesLists the menu's categories (sections) with their ids, names and storefront links.Arguments
Name Type Required sitestringA storefront URL ("https://anashawarma.square.site"), its host, or the bare name before .square.site.Yes Returns
SquareOnlineCategoryListinterface SquareOnlineCategory { /** Pass as `categoryId` to listMenuItems. */ id: string; name: string; parentId: string | null; depth: number; url: string; /** Products in this category and everything under it. */ productCount: number | null; type: string | null; } interface SquareOnlineCategoryList { site: string; /** Depth-first, each parent before its children. */ categories: SquareOnlineCategory[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/listCategoriesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.listCategories({ site: "anashawarma.square.site" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.listCategories({"site": "anashawarma.square.site"}))curl -X POST https://api.bowmark.ai/v1/sites/square_online/listCategories \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.listCategories({ site: "anashawarma.square.site" });listLocationsLists a storefront's locations: address, phone, description, pickup and delivery hours per weekday, time zone, whether scheduled pickup is on and how…Arguments
Name Type Required sitestringA storefront URL ("https://anashawarma.square.site"), its host, or the bare name before .square.site.Yes Returns
SquareOnlineLocationListinterface SquareOnlineHours { /** Local time, "HH:MM:SS". */ open: string; close: string; } interface SquareOnlineLocation { /** Pass as `locationId` to the per-location functions. */ id: string; name: string; description: string | null; address: { street: string | null; street2: string | null; city: string | null; region: string | null; postalCode: string | null; country: string | null } | null; phone: string | null; email: string | null; latitude: number | null; longitude: number | null; timezone: string | null; pickupEnabled: boolean; deliveryEnabled: boolean; /** Keyed "SUN".."SAT"; a day may have several spans. */ pickupHours: Record<string, SquareOnlineHours[]>; deliveryHours: Record<string, SquareOnlineHours[]>; prepTimeMinutes: number | null; schedulePickupEnabled: boolean; schedulePickupMaxDays: number | null; scheduleDeliveryEnabled: boolean; pickupInstructions: string | null; curbsidePickupEnabled: boolean; dineInEnabled: boolean; } interface SquareOnlineLocationList { site: string; locations: SquareOnlineLocation[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/listLocationsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.listLocations({ site: "anashawarma.square.site" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.listLocations({"site": "anashawarma.square.site"}))curl -X POST https://api.bowmark.ai/v1/sites/square_online/listLocations \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.listLocations({ site: "anashawarma.square.site" });listMenuItemsLists or searches a storefront's menu items with name, description, price range, image and sold-out state, paged; takes an optional text query and…Arguments
Name Type Required sitestringYes querystringFilters to items whose name/description matches, same search the menu page runs.No categoryIdstringFrom listCategories()/listMenuItems().No pagenumberNo perPagenumberDefault 25.No Returns
SquareOnlineMenuItemListinterface SquareOnlineMenuItemSummary { /** Pass as `itemId` to getMenuItem. */ id: string; /** The store's numeric product id, pass in `itemIds` to getItemAvailability. */ siteProductId: string | null; name: string; shortDescription: string | null; priceLow: number | null; priceHigh: number | null; priceFormatted: string | null; imageUrl: string | null; soldOut: boolean; visible: boolean; url: string; } interface SquareOnlineMenuItemList { site: string; items: SquareOnlineMenuItemSummary[]; page: number; perPage: number; totalPages: number; total: number; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/listMenuItemsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.listMenuItems({ site: "anashawarma.square.site" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.listMenuItems({"site": "anashawarma.square.site"}))curl -X POST https://api.bowmark.ai/v1/sites/square_online/listMenuItems \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.listMenuItems({ site: "anashawarma.square.site" });listMyOrdersLists the signed-in buyer's past orders at this store, for reordering.Arguments
Name Type Required sitestringYes pagenumber1-based page of 20 orders, newest first.No Returns
SquareOnlineMyOrdersinterface SquareOnlineMyOrders { site: string; customerId: string; page: number; /** The site's own order rows, unchanged. */ orders: Array<Record<string, unknown>>; /** The site's paging block, when it sent one. */ meta: Record<string, unknown> | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/listMyOrdersCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.listMyOrders({ site: "anashawarma.square.site" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.listMyOrders({"site": "anashawarma.square.site"}))curl -X POST https://api.bowmark.ai/v1/sites/square_online/listMyOrders \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.listMyOrders({ site: "anashawarma.square.site" });listMySubscriptionsLists the signed-in buyer's subscriptions at this store and their invoices.Arguments
Name Type Required sitestringA storefront URL ("https://anashawarma.square.site"), its host, or the bare name before .square.site.Yes Returns
SquareOnlineMySubscriptionsinterface SquareOnlineMySubscriptions { site: string; customerId: string; /** The site's own subscription rows, unchanged. */ subscriptions: Array<Record<string, unknown>>; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/listMySubscriptionsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.listMySubscriptions({ site: "anashawarma.square.site" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.listMySubscriptions({"site": "anashawarma.square.site"}))curl -X POST https://api.bowmark.ai/v1/sites/square_online/listMySubscriptions \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.listMySubscriptions({ site: "anashawarma.square.site" });listSubscriptionPlansLists the subscription plans a store sells (e.g. a weekly meal plan).Arguments
Name Type Required sitestringA storefront URL ("https://anashawarma.square.site"), its host, or the bare name before .square.site.Yes Returns
SquareOnlineSubscriptionPlansinterface SquareOnlineSubscriptionPlans { site: string; /** The site's own plan rows, passed through unchanged; empty when the store sells none. */ plans: Array<Record<string, unknown>>; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/square_online/listSubscriptionPlansCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.square_online.listSubscriptionPlans({ site: "anashawarma.square.site" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.square_online.listSubscriptionPlans({"site": "anashawarma.square.site"}))curl -X POST https://api.bowmark.ai/v1/sites/square_online/listSubscriptionPlans \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"site":"anashawarma.square.site"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.square_online.listSubscriptionPlans({ site: "anashawarma.square.site" });
Use it from code
- Node
npm i @bowmark/web - Python
pip install bowmark-web - HTTP
POST /v1/sites/square_online/<function> - OpenAPI
/v1/sites/square_online/openapi.json