How to Connect Other Apps With Unleashed API Access, and the API Limits

Before you start

• Only the Account Owner can see the API credentials.
• The API ID and Key are unique to each account, including each Sandbox account, and can't be changed or refreshed.
• Unleashed can't block an app once you've shared the credentials. Share them only with people and platforms you trust.
• Build and test against a Sandbox account, so development doesn't touch live data.
• Unleashed Support helps with how the product works, but doesn't write, review or debug API code.

Step 1: Find your API ID and Key

1. 1Log in to Unleashed as the Account Owner.
2. 2Go to Integration > Unleashed API Access.
3. 3View and copy your API ID and Key.

Step 2: Send the five required headers

1. 1Content-Type: application/xml or application/json.
2. 2Accept: application/xml or application/json.
3. 3api-auth-id: your API ID.
4. 4api-auth-signature: a signature generated for each request from the exact method, URL path and query string.
5. 5client-type: where the call comes from, in the format partner_name/app_name or account_name/app_name.

Step 3: Know your monthly limit

• The limit resets on the 1st of each calendar month at 12:00 AM UTC (11:00 AM AEDT, 1:00 PM NZST, 12:00 AM GMT).
• Unleashed emails you at 90%, 95% and 100% of the limit.
• At 90% and 95%, everything keeps working.
• At 100%, all API requests are blocked until the reset. Third-party integrations stop syncing and automated processes stop.
• Calls from apps that use your API ID and Key count toward the limit.
• Webhook events sent by Unleashed don't count.
• Native integrations don't count: CRM, Mintsoft, Xero, QuickBooks, Lightspeed and the eCommerce Hub's Shopify, Amazon and WooCommerce.

Step 4: Watch usage and add capacity

1. 1On the Unleashed API Access page, check the bar chart of calls per month for the last 12 months.
2. 2If a 90% or 95% warning arrives in the first 14 days of a month, ask your integration providers to look into it. Give them your list of active integrations, any 3PL shipping providers, and recent changes.
3. 3If a 90% warning arrives with fewer than 3 days left, Unleashed says no action is usually needed.
4. 4To add calls, go to Settings > Billing, select Modify next to Products, select Add on the Extra API Bundle tile, review and select Update, accept the Terms & Conditions, and click Upgrade.

If something doesn't look right

• 403 error: the auth signature is wrong. Regenerate it for that exact URL and query string, and check the ID and Key belong to the same account.
• 500 Internal Server Error: usually a formatting problem. Check headers, query parameters, pagination values and mandatory fields in the payload.
• Partial updates that blank out required fields cause errors. Send complete values.

Where Unleashed leaves the work to you

• Finding out which app used your calls. Unleashed doesn't keep a log of API connections, so you have to ask each provider.
• Planning around the hard stop. Only one extra API bundle can be added. Past that, calls stay blocked until the reset.
• Building and fixing custom integrations. That needs a developer who knows REST APIs.
• Removing the extra bundle. It renews with your subscription unless the Account Owner asks for it to be removed.

Where Logistify fits

Logistify is a managed service, not a connector or app, so this guide isn't about it. Its Sales Order Service enters customer orders into Unleashed as sales orders and creates sales quotes. If you're looking at AI assistants with Unleashed, see How to use ChatGPT or Claude with Unleashed. For what a native connection covers, see How to connect Shopify to Unleashed.