Getting an API key
On Pro and above, enable the API and generate a key from your Profile page. Keep it secret — you are responsible for all requests made with it. Only items you explicitly mark “include in API” are exposed.
Read and update inventory programmatically.
On Pro and above, enable the API and generate a key from your Profile page. Keep it secret — you are responsible for all requests made with it. Only items you explicitly mark “include in API” are exposed.
GET returns your API-included items as JSON. POST updates quantities (typically after a sale) by subtracting the amounts you send. Full request/response examples are on the API Documentation page.
Two endpoints cover the whole order life. GET /api/v1/orders lists orders (status open by default, or draft, confirmed, picking, packed, ready, shipped, cancelled; filter by customer; up to 200 at a time). POST /api/v1/orders creates one from a customer, lines of itemId and quantity, an optional note and an optional externalId (your order number, which makes the call safe to repeat); confirm: true reserves the stock at once. GET /api/v1/orders/SO-0012 returns one order by number or id with lines, reservations, shortfalls, shipment, tracking link and shipped lots. POST /api/v1/orders/SO-0012 acts on it: confirm, pick (itemId and quantity; negative undoes), ready (carrier, tracking number, order code), ship (carrier, tracking number, packages, weight), cancel (reason), reopen; an optional opId makes any action idempotent. Only the ship action deducts stock. Same key, quota and Include in API rule as the inventory endpoints. Webhooks are not available yet; poll the list with a status filter.
Every AI identification (photo, voice or text), AI spreadsheet import, bulk add, AI Assistant plan, AI Analyst answer and alert draft counts as one AI action, on the web and in the phone app. Each plan includes a monthly allowance: Pro 1,000, Super 3,000, VIP 10,000, Luxury 25,000, Space 60,000, with a per-minute limit sized for bulk photo adds. The Onboarding Officer, the ID check and Shelf Watch are not counted. You can see this month's usage on your Profile page; it resets on the 1st (UTC).
Each plan includes a monthly allowance of API calls, shared between the developer API and AI connectors (every MCP tool call counts as one): Pro 1,000, Super 5,000, VIP 25,000, Luxury 50,000, Space 200,000, plus a per-minute limit. Your Profile page shows this month's usage; the API returns the remaining amounts in X-Quota-* headers and answers 429 once a limit is reached, until the 1st of the next month. Polling with the since parameter and paging with cursor keeps you far inside the allowance. Full details under Limits in the API documentation.
Three things cover almost every failed connection. 1) Your workspace needs a paid membership that supports MCP (Pro or higher): on a Free account the connector can be added, but every request is declined. 2) Connect from a web browser, not the assistant's desktop or phone app: Google sign-in may not complete inside an app's built-in window. ChatGPT in particular must be connected from chatgpt.com in a browser; once connected there, the ChatGPT apps use the same connection. 3) Sign in with the Google account that owns the inventory, and make sure the items you ask about have Include in API enabled. If a previous attempt failed, remove the connector in the assistant and add it again. Connections you made are listed on your Profile under Connected AI apps.
Assistants connected through MCP (Claude, ChatGPT, Cursor and others) see where every item sits: its location (store or building), warehouse and aisle, by name. They can list what is low at one location, and when a product is stocked in several locations they see one record per location and are told to ask which one you mean before recording a sale, which always deducts from a single location's record. They can also filter by any custom field (brand, supplier, status, a Category field you defined…) with a value or just “filled in”, the same filter the inventory list offers, and they work on inventories of any size: listings come back a page at a time with a running cursor and a true count, and low-stock, expiring and summary figures cover every visible record. The REST API returns each record with its warehouse id.
If your business uses custom item fields (SKU, cost price, expiry date, your own fields…), every item in the GET response includes them in a fields object — so external systems get the full picture automatically.
Items are shared with the API and AI connectors only when “Include in API” is on. You can switch it on for a selection from the bulk action bar, and on large inventories (over 10,000 items) the banner at the top of the inventory list offers “Include every item in the API”: it runs on the server, shows how many items have been checked and added as it goes, and only touches items that are not included yet.
Every quantity update made through the API is recorded in your Activity Log as “Developer API”, and your AI Alert rules evaluate it like any scan — low-stock rules can fire (in-app, and by email on VIP+) seconds after an external sale.
Send your key as a Bearer token in the Authorization header on every request.