Want to connect your own reporting tool, warehouse system, or AI assistant to Airgoods? This guide explains how to get started from your seller account.
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 work with your Airgoods data. 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 sync on its own. Your tool still needs to be set up to use it. Existing integrations, such as Shopify or ShipStation, are managed separately.
What can your tool do?
Read information: View your brand’s products and orders for reports or internal workflows.
Make changes, if you allow them: Create or update products, update supported order details, and add fulfillment information.
Connect an AI assistant: Use a compatible assistant, such as Claude or Cursor, with the permissions you choose.
Your key works only for the brand you create it for. The API reference on your API page explains which actions and fields are supported.
1. Open your API page
Sign in to your Airgoods seller account.
Click Integrations in the left sidebar.
Select API underneath it.
2. Create a key
Click Create key.
Give the key a name you will recognize, such as “Warehouse reporting”.
Choose its permissions. These are called scopes in the form. Read-only permissions are selected by default.
Click Create key, then copy the full key and save it securely before clicking Done.
Start with read-only access. This lets your tool view information without changing it. Add write permissions only if the tool needs to make changes to your Airgoods products or orders.
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.
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.
Ask them to start by reading a product or order and checking the result. Before allowing a tool to make changes, review what it will update. Write actions can change real data in your Airgoods account.
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 simple request, such as “Show me my Airgoods products”.
The assistant has the same permissions as the key. Start with read-only access, and review any proposed changes before approving them.
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, and it does not reverse changes the tool has already made.
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 seller account you want to connect.
Your tool can view information but cannot change it
Check the permissions shown next to the key. If you need different permissions, create a new key with the required scopes and update your tool.
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 sidebar
Make sure you are signed in to the correct seller 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 seller API page for supported endpoints, fields, and examples.
Authenticate HTTP requests with
Authorization: Bearer YOUR_API_KEY, replacing YOUR_API_KEY with the full secret.Use seller endpoints. Retailer keys and seller keys are not interchangeable.
Product creation and fulfillment creation require an
Idempotency-Keyheader. Follow the API reference for required headers and safe retries.
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.
