Heartland Retail MCP server

Read items, stock, customers and sales orders; create and update customers in Heartland Retail. Hosted by usefulapi: connect it to Claude, ChatGPT, Cursor or any MCP client.

Connect Heartland RetailFree 50 tool calls / monthPro $9/mo · $90/yr · pricing20 tools

What can I ask?

Turn on the Heartland Retail connector, then ask in plain words. The AI picks the tools.

What you can do with Heartland Retail in Claude and ChatGPT

For store managers and retail staff who look up stock, customers and orders in Heartland Retail.

Check stock quantities by location

List the store's locations to find their ids. Then list the inventory values, grouped by location, to read the stock quantities and values the tool returns.

Find a customer by email and review their orders

Search the customers by email and open the match to read its details and loyalty points. Then search the sales orders for that customer's name.

Review pending sales orders and their lines

List the sales orders filtered by status, such as pending. Open one order to read its lines with the items, quantities and prices.

Check a gift card or a POS sale

Read the value and status of a gift card by its card number. Search the point-of-sale tickets for a till sale.

Create a customer or change a customer's email

Create a customer with a first name or a last name. Or update the name or email of an existing customer. Only the fields you give change.

Changes data

How do I connect Heartland Retail?

Before you connect

The login page asks for your Store subdomain and Heartland Retail API token.

The subdomain is the part before .retail.heartland.us in your store address. To create the token, click your name in the top right of Heartland Retail, then my account → API → Generate new token. The token is used only to call your store's API.

Claude claude.ai · Desktop

  1. Open Customize → Connectors, then click + Add → Add custom connector.
  2. Enter the name Heartland Retail and this URL, then click Add:
    https://heartland-retail.usefulapi.io/mcp
  3. Claude opens the login page: enter your Store subdomain and Heartland Retail API token.
  4. In a chat, click + → Connectors and turn on Heartland Retail.

Team and Enterprise: an Owner adds the connector for the organization first.

ChatGPT chatgpt.com

  1. Open Plugins, click +, then Add custom MCP server.
  2. Enter the name Heartland Retail and this URL, choose OAuth as the authentication, confirm the warning and create it:
    https://heartland-retail.usefulapi.io/mcp
  3. ChatGPT opens the login page: enter your Store subdomain and Heartland Retail API token.
  4. In Plugins, install Heartland Retail, then choose it in a chat.

No Add custom MCP server option? It depends on your account or workspace settings: see OpenAI's guide.

Claude Code

Run this command, then run /mcp in Claude Code to log in:

claude mcp add --transport http heartland-retail https://heartland-retail.usefulapi.io/mcp

Cursor

Add to Cursor or add this to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "heartland-retail": {
      "url": "https://heartland-retail.usefulapi.io/mcp"
    }
  }
}

VS Code

Add to VS Code or add this to .vscode/mcp.json:

{
  "servers": {
    "heartland-retail": {
      "type": "http",
      "url": "https://heartland-retail.usefulapi.io/mcp"
    }
  }
}

Codex

Run these commands. The second one opens the login page:

codex mcp add heartland-retail --url https://heartland-retail.usefulapi.io/mcp
codex mcp login heartland-retail

Other clients

Windsurf, Cline, Zed and other MCP clients: add this URL as a remote MCP server (Streamable HTTP). The client then opens the login page in your browser.

https://heartland-retail.usefulapi.io/mcp

Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Store subdomain and Heartland Retail API token. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.

Pricing

PlanPriceLimit
Free$050 tool calls / month
Proper user$9/mo · $90/yr10,000 tool calls / month
Pro+per user$39/mo · $390/yr100,000 tool calls / month

Each paid plan covers this Heartland Retail server only. Ask your AI to run heartlandretail_upgrade and choose Pro or Pro+, billed monthly or yearly (it returns a Stripe Checkout link). If you already have Pro, ask to change it to Pro+. The change requires your confirmation, keeps your billing interval and charges the price difference for the rest of the period immediately. Cancel any time with heartlandretail_cancel_subscription: your paid plan continues to the end of the paid period, with no refund for the current period, and asking to resume the same plan with heartlandretail_upgrade before then undoes the cancel. Or write to [email protected].

Tools 20

Show all 20 tools (the AI picks them for you)

Read only · 14

  • Show the connected userheartlandretail_whoami
    Show the Heartland Retail user behind the API token, and confirm the token works. Use it first when a call returns 401 or 403.
  • List itemsheartlandretail_list_items
    Search the store's items (products) by text or JSON filter, with cost, price and vendor ids.
  • Get itemheartlandretail_get_item
    Get one item by id: cost, price, financial class and primary vendor.
  • List inventory valuesheartlandretail_list_inventory_values
    Show stock quantities and values, optionally grouped (for example by item_id or location_id) and filtered to one item.
  • List locationsheartlandretail_list_locations
    List the store's locations (stores, warehouses) with their ids.
  • List customersheartlandretail_list_customers
    Search customers by name, email or a JSON filter.
  • Get customerheartlandretail_get_customer
    Get one customer by id: name, email, default address ids, custom fields and loyalty points.
  • List sales ordersheartlandretail_list_sales_orders
    Search sales orders by text or JSON filter (for example a status). Shows customer, status, shipping and totals.
  • Get sales orderheartlandretail_get_sales_order
    Get one sales order by id.
  • List sales order linesheartlandretail_list_sales_order_lines
    List the lines (items, quantities, prices) of one sales order.
  • List sales invoicesheartlandretail_list_sales_invoices
    Search sales invoices by text or JSON filter.
  • List POS ticketsheartlandretail_list_sales_tickets
    Search point-of-sale tickets (till sales) by text or JSON filter.
  • List vendorsheartlandretail_list_vendors
    Search purchasing vendors (suppliers) by text or JSON filter.
  • Get gift cardheartlandretail_get_gift_card
    Get one gift card by its card number: value and status.

Changes data · 2

  • Create customerheartlandretail_create_customer
    Create a customer. Give a first name or a last name (or both). Returns the new customer id.
  • Update customerheartlandretail_update_customer
    Change the name or email of one customer. Only the fields you give change.

Your usefulapi plan · 4

  • Usage status (free-tier meter)heartlandretail_usage_status
    Report the caller's current usage: the plan, calls used this month, the limit of the plan (the free monthly cap or the Pro fair use limit), remaining, and whether the limit is reached. Read-only; does not count against the meter.
  • Request a missing featureheartlandretail_request_feature
    Tell usefulapi that the user needs something the Heartland Retail tools cannot do yet (a missing tool, field or filter). Call it only when the user asks for something none of the tools can do, and tell the user that you send the request. Do not call it for errors or for normal requests. Do not include personal data, credentials or customer records. Stored with the product name and the client type (for example Claude or Cursor), without the user's account. At most 5 requests per day. Does not count against the meter.
  • Upgrade to Pro or Pro+heartlandretail_upgrade
    Get a paid plan for Heartland Retail (the free tier caps monthly usage). Pro: 10,000 tool calls a month, for normal use — plan "monthly" ($9/month) or "yearly" ($90/year, 2 months free). Pro+: 100,000 tool calls a month, for automations and heavy use — plan "plus" ($39/month) or "plus_yearly" ($390/year). Without a plan it returns both Pro and Pro+, each with a payment link, for the user to choose; with a plan, one link. An existing Pro subscription changes to Pro+ in place (needs confirm: true; the price difference for the rest of the period is charged at once). Cancel any time: the plan then runs to the end of the paid period, so it also suits a one-time job. A link opens Stripe Checkout in the browser; after payment the account upgrades automatically. Does not count against the meter.
  • Cancel the Pro subscriptionheartlandretail_cancel_subscription
    Cancel the caller's Heartland Retail Pro subscription at the end of the paid period (no refund for the current period; Pro continues until then, then the free tier applies). Requires confirm: true. Run heartlandretail_upgrade later to undo the cancel before the period ends. Does not count against the meter.

FAQ

What can I do with Heartland Retail in Claude or ChatGPT?

Check stock quantities by location. Find a customer by email and review their orders. Review pending sales orders and their lines. Check a gift card or a POS sale. Create a customer or change a customer's email. See what you can do for the details.

Is this an official Heartland Retail product?

No. usefulapi is an independent service. It is not affiliated with or endorsed by Heartland Retail. The server calls the Heartland Retail API with your own Heartland Retail access, so it sees only the data that your account can see.

Can I connect Heartland Retail to Claude or ChatGPT?

Yes. In Claude, add this server's URL as a custom connector. In ChatGPT, add it as a custom MCP server in Plugins. Then log in once. Cursor, VS Code, Claude Code and Codex work too. See the setup steps.

What do I need to connect?

The login page asks for your Store subdomain and Heartland Retail API token. See Before you connect for where to find them.

Do I put my Heartland Retail key or an Authorization header in the client config?

No. Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Store subdomain and Heartland Retail API token. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.

How do you keep my Heartland Retail credentials?

The login stores them encrypted in the authorization grant of your connection. The server uses them to call the Heartland Retail API for you and to derive a private account id for usage metering. usefulapi does not show them on any page or in any reply. To stop all access, remove the connector and change or delete these credentials in Heartland Retail.

Can the AI change my Heartland Retail data?

Yes, if you approve it. 2 of the 16 Heartland Retail tools can create or change data. The other 14 are marked read-only. Most MCP clients ask you to approve a tool call before it runs.

What does it cost?

The Free plan gives 50 tool calls / month. Pro costs $9/mo or $90/yr, with 10,000 tool calls / month. Pro+ costs $39/mo or $390/yr, with 100,000 tool calls / month. Each subscription covers this Heartland Retail server only. Cancel any time: your paid plan then runs to the end of the paid period. Run heartlandretail_usage_status to see how many calls you used.

How do I subscribe or cancel?

Ask the AI to run heartlandretail_upgrade and choose Pro or Pro+, billed monthly or yearly: it returns a Stripe Checkout link. If you already have Pro, ask to change it to Pro+. After you confirm, your existing subscription changes in place, keeps its billing interval and charges the price difference for the rest of the period immediately. To cancel, run heartlandretail_cancel_subscription. Your paid plan continues to the end of the paid period.

What if a Heartland Retail tool that I need is missing?

Tell the AI what you wanted to do. It can send the request with heartlandretail_request_feature. We store the text with the server name, the type of AI client and the tool you tried, not with your account, and read every request when we plan new tools. You can send up to 5 requests per day.

Which AI clients can I use?

Any client that supports remote MCP servers (Streamable HTTP) with OAuth login: Claude (web and desktop), Claude Code, ChatGPT, Codex, Cursor, VS Code, Windsurf and others.

This is a Model Context Protocol endpoint — meant to be connected from an AI client, not opened in a browser. An invalid_token response at the URL is the auth gate working as designed; clients authenticate automatically.

Need a tool this server does not have, or a connection to another system? We build custom integrations and MCP servers.

More Commerce & Memberships MCP servers

ApiloAwtomicBeacon CRMBettermodeBloomerangbol.comBooqableBrandboomBreeze ChMSBrightpearlBsaleBSS B2B SolutionBuy Me a CoffeeCatalog MachineCCV ShopChannableChannel Pilot ProChannelEngineCharityFundraiserCin7 CoreConsignCloudCratejoyCustomCatDecoNetworkEasyStoreEcwidEffectConnectElvantoEveniumEventbriteFinale InventoryFinerWorksFitsseyFoxy.ioFunraiseGelatoGift Up!GiftbitGivecloudGivingFuelGoDataFeedGood GrantsGootenGumroadHello ClubHiboutikHumanitixIdoSellInventory PlannerJubelioKiotVietKoursesLearnWorldsLengowLibibLightspeed Retail (R-Series)Lightspeed Retail (X-Series)LinnworksLittle Green LightLooxLoyverseMarketTimeMegaventoryMemberfulMemberRunMembers.devMemberSuiteMemberVaultMyOnlineStoreNembolNeon CRMOpenWaterOrder DeskOwnerRezPatreonPHP Point of SalePlentyONEpretixPrice2SpyPrintfulPrintifyPrisyncProdigiQgivRackbeatRaiselyRechargeRecurpayReturnLogicREVIEWS.ioRock Gym ProSalesBinderSalsa EngageSamitaSapoSearchaniseSellasistSelloShoprocketSmaregiSmile.ioSOS InventorySpektrixStampedSteadyStoreRocketSugarWODSwellTeamUpTicimaxTicketsauceTicketSpiceTillhubTiltifyTitoTourCMSUniverseUnleashed SoftwareVeeqoVirtuousWhite Label LoyaltyWild ApricotZettleZylvie

All Commerce & Memberships servers →