Integrating GoKarla with ArminCX

Connect your GoKarla account to ArminCX and give your support agents instant access to order and shipment data — without leaving the conversation.

What is GoKarla?

GoKarla (also referred to as "Karla") is a post-purchase platform for e-commerce brands. It handles order tracking, shipment status, and returns management. By connecting GoKarla to ArminCX, your agents can pull live order and shipment data directly inside a customer conversation — no tab-switching, no copy-pasting order numbers.

What the Integration Does

Once connected, ArminCX gives you two actions you can use inside any conversation:

These actions can be triggered manually by an agent, or used as part of an automated workflow.

Prerequisites

Before you start, make sure you have:

• An active GoKarla account with API access enabled

• Your GoKarla subdomain URL (e.g. https://yourshop.gokarla.io)

• A GoKarla API key — generated in your GoKarla Settings under API / Developer

• Admin access to your ArminCX workspace

Note for devs: GoKarla's API uses HTTP Basic Authentication. Your username is the one assigned to the API key (defaults to your shop slug). Your password is the generated API key/token. You can find and generate these in GoKarla under Settings → API.

Step-by-Step: Connecting GoKarla to ArminCX

1. Open Integrations in ArminCX

Navigate to your ArminCX workspace and go to:

Settings → Integrations → All Integrations

Search for GoKarla and click on it.

2. Go to the Accounts Tab

Click the Accounts tab on the GoKarla integration page, then click + Add account.

3. Fill in Your Credentials

A modal will appear asking for three fields:

Tip: Don't include a trailing slash in the URL. Use https://yourshop.gokarla.io, not https://yourshop.gokarla.io/.

4. Connect

Click Connect. ArminCX will validate your credentials against the GoKarla API. If the connection is successful, your account will appear under Accounts connected.

Using the Integration

Once connected, the GoKarla integration is available inside conversations in ArminCX.

Get Order

Use this action to pull up a customer's order details in real time.

How to trigger: In any open conversation, open the Integrations panel (or use the action shortcut), select GoKarla → Get Order, and enter the order ID or reference number.

What you get back:

• Order status (e.g. pending, fulfilled, cancelled)

• Line items and quantities

• Customer name and shipping address

• Payment status

• Fulfillment and tracking reference

Get Shipment

Use this action to check the live shipment status for a customer's package.

How to trigger: Select GoKarla → Get Shipment and enter the shipment ID or tracking reference.

What you get back:

• Carrier name and tracking number

• Current shipment status (e.g. in transit, delivered, delayed)

• Last tracking event with timestamp

• Estimated delivery date (if available)

For Developers: API Authentication Reference

GoKarla uses HTTP Basic Auth on all API v1 endpoints.

Base URL: https://{your-shop-slug}.gokarla.io/api/v1/

Authentication: Basic Auth
  Username: your API username (default: shop slug)
  Password: your API token

ArminCX handles the authentication internally once you've stored your credentials via the integration setup. You don't need to pass headers manually unless you're building a custom integration on top of the GoKarla API directly.

Full API reference: https://docs.gokarla.io/api/v1/

Troubleshooting

Connection fails on setup

• Double-check your GoKarla URL — make sure it matches your exact GoKarla subdomain and has no trailing slash

• Verify that your API token is active in GoKarla Settings. Regenerate it if needed

• Make sure your GoKarla account has API access enabled (some plans may restrict this)

"Get Order" returns no results

• Check that the order ID exists in your GoKarla account

• Make sure the order is associated with the GoKarla account you connected (relevant if you run multiple shops)

"Get Shipment" shows no tracking data

• Shipment data is only available once a shipment has been created and a carrier has been assigned in GoKarla

• If the order was recently fulfilled, wait a few minutes for the data to sync

API token stopped working

• API tokens can be revoked or regenerated in GoKarla. If your token was reset, go to ArminCX → Integrations → GoKarla → Accounts, remove the existing account, and add it again with the new token.