Want to use Airgoods product information in a buying tool or AI assistant? This guide explains how to connect the catalog available to your store.
You can create a key yourself. For a custom connection, you may also need help from your developer or the company that provides your tool.
Before you start
An API lets another tool access information from Airgoods. An API key is a secret code that gives that tool permission to connect—treat it like a password.
Creating a key does not start a product import or sync on its own. Your tool still needs to be set up to use it. Your POS integration, if you have one, is managed separately.
What can your tool do?
Search the Airgoods catalog available to your store.
Look up product details for buying research, planning, or reports.
Use a compatible AI assistant, such as Claude or Cursor, to search and look up products.
Retailer access is read-only. Your tool can view product information. It cannot place orders, add items to your cart, change products, or use seller order and fulfillment tools.
1. Open your API page
Sign in to your Airgoods retailer account.
Open your account navigation and select Integrations.
Select API underneath it.
2. Create a key
Click Create key.
Give the key a name you will recognize, such as “Buying research”.
Keep Read products selected. This is the permission available for retailer keys. Permissions are called scopes in the form.
Click Create key, then copy the full key and save it securely before clicking Done.
Save the key now: You will only see the full secret once. The short prefix shown in your key list helps you identify the key; it cannot be used to connect a tool.
Only share the full key with people or tools you authorize to access your store’s catalog.
3. Connect your tool
Add the key to your tool’s secure connection settings, or ask your developer to do this for you. The setup steps depend on the tool.
Start with a simple product search and check the results. Your key uses the catalog available to the store it belongs to, so make sure you created it in the retailer account you intended to connect.
The API reference at the top right of your API page has the technical instructions your developer may need.
Optional: Connect an AI assistant
MCP is a way for an AI assistant to connect to tools like Airgoods. Your assistant must support a remote MCP connection with an API key; the available settings vary by app.
On your Airgoods API page, find AI assistants (MCP).
Click Copy next to the server URL. This is the connection address for your assistant.
Open your assistant’s MCP or custom connector settings and add that address.
Add your full API key using the client’s Bearer token authentication settings. If you are unsure which field to use, ask your developer or contact us.
Try a request such as “Search the Airgoods catalog for sparkling water” or “Show me details for this product”.
The assistant can look up products available to your store. It cannot place an order or change products through the retailer API.
Manage or disconnect a key
Return to your API page to see each key’s name, permissions, creation date, and last-used time. Use Search keys to find one by name or prefix.
To disconnect a tool, click Revoke next to its key and confirm. That key stops working immediately. This cannot be undone.
If you lose a key, create a replacement, update your tool, check that it works, and then revoke the old key. If you think someone else has your key, revoke it right away.
Having trouble?
“Authentication failed” or “Invalid key”
Check that your tool uses the full key—not the short prefix—with no extra spaces. The key must still be active and must have been created in the retailer account you want to connect.
Your search returns no products or unexpected results
Check the search filters and which store the key belongs to. Product visibility follows the rules for that store. Compare the results with the catalog you see when signed into the same account.
Your AI assistant will not connect
Copy the server URL from Airgoods again. Check that the assistant supports a remote MCP server with API-key authentication.
You cannot find API in the menu
Make sure you are signed in to your retailer account. Contact us if it is still missing.
For your developer
You can share this section with the person setting up your connection.
Open API reference at the top right of the retailer API page for available search filters, request formats, and examples.
Authenticate HTTP requests with
Authorization: Bearer YOUR_API_KEY, replacing YOUR_API_KEY with the full secret.Use retailer endpoints. A retailer key cannot call seller endpoints.
The key has
read:productsaccess and is tied to its store. Product results follow that store’s visibility rules.
Need a hand?
Contact us through live chat on Airgoods or email [email protected]. Tell us the tool you are connecting, the step you reached, and any error message.
Please do not send your full API key. The key name or prefix is enough to help us identify it.
