usefulapiBrightpearl MCP server
Search Brightpearl orders, products, stock, contacts and payments; add notes, update order status. Hosted by usefulapi: connect it to Claude, ChatGPT, Cursor or any MCP client.
What can I ask?
Turn on the Brightpearl connector, then ask in plain words. The AI picks the tools.
- Which sales orders were placed yesterday and are still waiting to be shipped?
- How much stock of SKU ABC-123 do we have in each warehouse?
- Show the full details and notes of order 100182.
- Find the customer with the email anna@example.com and list their latest orders.
What you can do with Brightpearl in Claude and ChatGPT
For retailers and wholesalers who run orders, stock and accounting in Brightpearl.
Find sales orders that still wait to be shipped
The AI searches orders by type, status and dates, then opens them to see statuses, totals and order rows.
Check stock of a product in each warehouse
The AI finds a product by SKU and reads in-stock, on-hand, allocated and in-transit quantities per warehouse.
Look up a customer and their latest orders
The AI searches contacts by email or name, reads the contact record, and finds the orders placed by that contact.
Check payments and shipments of orders
The AI searches customer payments received against sales orders and goods-out notes, which show picked, packed and shipped state.
Add a note or change the status of an order
The AI adds a private or public note to an order, or moves the order to another status. A status change can trigger other actions in Brightpearl.
Changes dataHow do I connect Brightpearl?
Before you connect
The login page asks for your Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app token.
In Brightpearl open App Store → Private Apps → Add Private App (an account administrator with the settings permission). Choose a staff app (the token acts as one staff member and respects that member's permissions) or a system app (account token). Copy the app's reference and token. The account code and data centre are in your Brightpearl address: euw1.brightpearlapp.com/mycompany.login is data centre euw1, account mycompany. Your credentials are used only to call the Brightpearl API on your behalf; they are never shown to anyone.
Claude claude.ai · Desktop
- Open Customize → Connectors, then click + Add → Add custom connector.
- Enter the name Brightpearl and this URL, then click Add:https://
brightpearl. usefulapi. io/ mcp - Claude opens the login page: enter your Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app token.
- In a chat, click + → Connectors and turn on Brightpearl.
Team and Enterprise: an Owner adds the connector for the organization first.
ChatGPT chatgpt.com
- Open Plugins, click +, then Add custom MCP server.
- Enter the name Brightpearl and this URL, choose OAuth as the authentication, confirm the warning and create it:https://
brightpearl. usefulapi. io/ mcp - ChatGPT opens the login page: enter your Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app token.
- In Plugins, install Brightpearl, 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:
Cursor
Add to Cursor or add this to ~/.cursor/mcp.json:
{
"mcpServers": {
"brightpearl": {
"url": "https://brightpearl.usefulapi.io/mcp"
}
}
} VS Code
Add to VS Code or add this to .vscode/mcp.json:
{
"servers": {
"brightpearl": {
"type": "http",
"url": "https://brightpearl.usefulapi.io/mcp"
}
}
} Codex
Run these commands. The second one opens the login page:
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.
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 Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app 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
| Plan | Price | Limit |
|---|---|---|
| Free | $0 | 50 tool calls / month |
| Proper account | $9/mo · $90/yr | 10,000 tool calls / month |
| Pro+per account | $39/mo · $390/yr | 100,000 tool calls / month |
Each paid plan covers this Brightpearl server only. Ask your AI to run brightpearl_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 brightpearl_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 brightpearl_upgrade before then undoes the cancel. Or write to support@usefulapi.io.
Tools 29
Show all 29 tools (the AI picks them for you)
Read only · 22
- Get account configuration
brightpearl_get_account_configurationThe Brightpearl account's configuration as key/value pairs: base currency, tax scheme, time zone, default and new-order status ids, nominal codes, weight unit, whether multiple warehouses are enabled. - Search orders
brightpearl_search_ordersSearch sales orders, sales credits, purchase orders and purchase credits. Every filter is optional and they combine (AND); each result row has orderId, orderTypeId, contactId, orderStatusId, orderStockStatusId, createdOn, updatedOn, customerRef, externalRef, warehouseId and more. Use brightpearl_get_orders for the full order. Order type ids: brightpearl_list_order_types; status ids: brightpearl_list_order_statuses. - Get orders
brightpearl_get_ordersFull details of one or more orders by id: type, status, payment/stock/shipping status, dates, currency, totals, assignment, customer/supplier, billing and delivery parties, and the order rows (product, quantity, price, tax). Up to 50 ids. - Get order notes
brightpearl_get_order_notesAll notes on one order (text, author contact id, date, whether it is public on the customer portal, the order status at the time). - List order statuses
brightpearl_list_order_statusesThe account's order statuses (id, name, order type code SO/PO/SC/PC, sort order, disabled, visible to the customer, state such as draft). Use the ids to filter orders or to change an order's status. - List order types
brightpearl_list_order_typesThe four order types with their ids and codes (1 SO sales order, 2 PO purchase order, 3 SC sales credit, 4 PC purchase credit), for the order search. - Search products
brightpearl_search_productsSearch the product catalogue. Every filter is optional and they combine (AND); each result row has productId, productName, SKU, barcode, EAN, UPC, ISBN, MPN, stockTracked, createdOn, updatedOn, brightpearlCategoryCode, productGroupId, brandId, productTypeId, productStatus, primarySupplierId. Use brightpearl_get_products for full details. - Get products
brightpearl_get_productsFull details of one or more products by id: identity (SKU, barcodes), brand, type, stock-tracking, weight and dimensions, tax code, sales-channel names/descriptions/categories, bundle composition, variations, per-warehouse reorder levels, supplier and status. Up to 50 ids. - Get product prices
brightpearl_get_product_pricesPrices of products per price list: for each product and price list the currency, SKU and the quantity-break price map (e.g. {"1":"12","100":"11"}). Up to 50 product ids; optionally only some price lists (ids from brightpearl_list_price_lists). GET /product-service/product-price/{product ids}/price-list/{price list ids}. - Get product stock availability
brightpearl_get_product_availabilityStock availability of stock-tracked products: for each product the totals across all warehouses (inStock, onHand, allocated, inTransit) and the same per warehouse; optionally per location, with on-order quantities. Up to 50 product ids. - List price lists
brightpearl_list_price_listsThe price lists (id, name, code, currency, SELL or BUY, gross or net). Id 0 is the cost price list. - Search brands
brightpearl_search_brandsSearch product brands by name; each row has brandId, brandName, createdOn, updatedOn. - Search product categories
brightpearl_search_categoriesSearch Brightpearl product categories; each row has id, name, parentId, active, createdOn, updatedOn. - List warehouses
brightpearl_list_warehousesThe warehouses (id, name, type, address id, click-and-collect settings, weekly operating hours). Use the ids for stock and order filters. - List shipping methods
brightpearl_list_shipping_methodsThe shipping methods (id, name, code, carrier, price breaks, countries). - Search goods-out notes (shipments)
brightpearl_search_goods_out_notesSearch goods-out notes, the pick/pack/ship records of sales orders; each row has goodsOutNoteId, printed, picked, packed, shipped, shippedOn, orderId, shippingMethodId, warehouseId, createdOn, releaseDate, transfer. - Search goods-in notes (stock received)
brightpearl_search_goods_in_notesSearch goods-in records (stock received against purchase orders, by batch and location); each row has purchaseOrderId, batchId, productId, locationId, price, currCode, receivedQuantity, onHand, createdDate, receivedDate, warehouseId. - Search contacts
brightpearl_search_contactsSearch contacts (customers, suppliers and staff). Every filter is optional and they combine (AND); each result row has contactId, primaryEmail, firstName, lastName, companyName, isSupplier, isStaff, isCustomer, createdOn, updatedOn, lastOrderedOn and more. Use brightpearl_get_contacts for the full record. - Get contacts
brightpearl_get_contactsFull records of one or more contacts by id: name, emails, phones, status, supplier/staff flags, financial details (price list, tax code, credit limit and terms), assignment, organisation, tags, dates; optionally custom fields and the full postal addresses. Up to 50 ids. - Search customer payments
brightpearl_search_customer_paymentsSearch payments received against sales orders; each row has paymentId, transactionRef, paymentMethodCode, paymentType, orderId, currencyCode, amountAuthorized, amountPaid, paymentDate, createdOn, journalId. - List payment methods
brightpearl_list_payment_methodsThe payment methods (name, code, active, bank accounts with currency and nominal code). - List tax codes
brightpearl_list_tax_codesThe tax codes (id, code, description, rate).
Changes data · 3
- Add order note
brightpearl_add_order_noteWRITE: add a note to an existing order. The note is private (staff only) unless is_public is true, which makes it visible on the customer portal. Returns the new note id. Notes cannot be removed with this server. - Update order status
brightpearl_update_order_statusWRITE: move an existing order to another status (ids from brightpearl_list_order_statuses; the new status must exist, be visible and belong to this order's type). Brightpearl adds an order note on success, and status changes can trigger the account's alerts and automations. Moving a sales order to the account's 'cancelled' status removes its reservations and coupons and is refused while goods-out notes or payments exist. - Add contact note
brightpearl_add_contact_noteWRITE: add a note to a contact's timeline (for example a record of correspondence). The note is private (staff only) unless is_public is true, which makes it visible on the customer portal. Returns the new note id. Notes cannot be removed with this server.
Your usefulapi plan · 4
- Usage status (free-tier meter)
brightpearl_usage_statusReport 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 feature
brightpearl_request_featureTell usefulapi that the user needs something the Brightpearl 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+
brightpearl_upgradeGet a paid plan for Brightpearl (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: call without confirm first, as the reply states the exact charge for this account (the price difference for the rest of the period, or in a free Pro trial the full Pro+ price, as the trial ends); then call with confirm: true. 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 subscription
brightpearl_cancel_subscriptionCancel the caller's Brightpearl 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 brightpearl_upgrade later to undo the cancel before the period ends. Does not count against the meter.
FAQ
What can I do with Brightpearl in Claude or ChatGPT?
Find sales orders that still wait to be shipped. Check stock of a product in each warehouse. Look up a customer and their latest orders. Check payments and shipments of orders. Add a note or change the status of an order. See what you can do for the details.
Is this an official Brightpearl product?
No. usefulapi is an independent service. It is not affiliated with or endorsed by Brightpearl. The server calls the Brightpearl API with your own Brightpearl access, so it sees only the data that your account can see.
Can I connect Brightpearl 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 Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app token. See Before you connect for where to find them.
Do I put my Brightpearl 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 Account code, Data centre (first part of your Brightpearl address), Private app reference, Token type and Private app 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 Brightpearl credentials?
The login stores them encrypted in the authorization grant of your connection. The server uses them to call the Brightpearl 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 Brightpearl.
Can the AI change my Brightpearl data?
Yes, if you approve it. 3 of the 25 Brightpearl tools can create or change data. The other 22 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 Brightpearl server only. Cancel any time: your paid plan then runs to the end of the paid period. Run brightpearl_usage_status to see how many calls you used.
How do I subscribe or cancel?
Ask the AI to run brightpearl_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 brightpearl_cancel_subscription. Your paid plan continues to the end of the paid period.
What if a Brightpearl tool that I need is missing?
Tell the AI what you wanted to do. It can send the request with brightpearl_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.