Skip to main content

Developer resources

Welcome to the Karla developer hub. Everything you need to integrate with our platform - API references, data models, SDKs, and guides.

Getting Started​

To get started with the GoKarla API, you'll need:

  1. API Key - Generate an API key from your GoKarla Dashboard
  2. Shop Slug - Your unique shop identifier
  3. HTTP Client - Any HTTP client that supports RESTful APIs

Quick Example​

Here's a simple example to get your shop details:

curl https://api.gokarla.io/v1/shops/your-shop-slug \
  -H "Authorization: Basic <base64-encoded-`username:api-key`>"

Core Resources​

The GoKarla API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.

Main Resources​

Campaigns

Create and manage marketing campaigns for your post-purchase flow

Orders

Track and update customer orders throughout their journey

Shipments

Monitor shipment status and tracking events

Webhooks

Receive real-time notifications for important events

Data Flow​

Understanding how data flows through Karla helps you build better integrations:

  1. Order Creation → Order entity created with customer and product data
  2. Draft Shipment Generation → Expected shipments created for customer visibility
  3. Shipment Fulfillment → Draft becomes tracking when first carrier scan occurs
  4. Event Tracking → Events generated as tracking progresses through delivery
  5. Campaign Triggering → Campaigns activate based on tracking events and segments
  6. Analytics Collection → Performance data aggregated for insights

Common Data Patterns​

Timestamps​

All timestamps in Karla use ISO 8601 format with timezone offset:

"created_at": "2024-01-29T14:48:47+00:00"

UUIDs​

Karla uses UUID v4 for all entity identifiers:

"uuid": "abc65a96-0871-452a-a506-c644e2012123"

External References​

Many entities include external IDs to link with your platform:

"external_id": "order_12345_from_shopify"

Contextual Information​

Every event provides context of the models involved with it.

{
  "context": {
    "order": {
      /* Full order object */
    },
    "customer": {
      /* Customer information */
    },
    "shipments": [
      /* All related shipments */
    ],
    "claims": [
      /* All related claims */
    ]
  }
}

Support​