kiriminaja

README

KiriminAja Go SDK

Official Go SDK for the KiriminAja logistics API. Zero dependencies beyond the standard library.

Requirements

• Go 1.21+

Installation

go get github.com/kiriminaja/go

---

Quick Start

Create a client with kiriminaja.New(), then call any service method.

package main

import (
    "fmt"
    "log"
    "os"

    kiriminaja "github.com/kiriminaja/go"
)

func main() {
    client := kiriminaja.New(kiriminaja.Config{
        Env:    kiriminaja.EnvSandbox, // or kiriminaja.EnvProduction
        APIKey: os.Getenv("KIRIMINAJA_API_KEY"),
    })

    // Use any service
    provinces, err := client.Address.Provinces()
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("Provinces: %+v\n", provinces)
}

---

Config Options

Option	Type	Default	Description
Env	Env	EnvSandbox	Target environment
APIKey	string	—	Your KiriminAja API key
BaseURL	string	Derived from Env	Override the base URL
HTTPClient	*http.Client	http.DefaultClient	Custom HTTP client (proxy / test mock)

// Custom base URL
client := kiriminaja.New(kiriminaja.Config{
    BaseURL: "https://tdev.kiriminaja.com",
    APIKey:  os.Getenv("KIRIMINAJA_API_KEY"),
})

// Custom HTTP client (e.g. with timeout or transport)
client := kiriminaja.New(kiriminaja.Config{
    APIKey: "...",
    HTTPClient: &http.Client{Timeout: 10 * time.Second},
})

---

Services

Address

// List all provinces
client.Address.Provinces()

// Cities in a province (provinsi_id)
client.Address.Cities(5)

// Districts in a city (kabupaten_id)
client.Address.Districts(12)

// Sub-districts in a district (kecamatan_id)
client.Address.SubDistricts(77)

// Search districts by name
client.Address.DistrictsByName("jakarta")

---

Coverage Area & Pricing

// Express shipping rates
client.CoverageArea.PricingExpress(types.PricingExpressPayload{
    Origin:      1,
    Destination: 2,
    Weight:      1000, // grams
    ItemValue:   50000,
    Insurance:   0,
    Courier:     []string{"jne", "jnt"},
})

// Instant (same-day) rates
client.CoverageArea.PricingInstant(types.PricingInstantPayload{
    Service:   []string{"instant"},
    ItemPrice: 10000,
    Origin:    types.PricingInstantLocationPayload{Lat: -6.2, Long: 106.8, Address: "Jl. Sudirman No.1"},
    Destination: types.PricingInstantLocationPayload{Lat: -6.21, Long: 106.81, Address: "Jl. Thamrin No.5"},
    Weight:    1000,
    Vehicle:   "motor",
    Timezone:  "Asia/Jakarta",
})

---

Order — Express

// Track by order ID
client.Order.Express.Track("ORDER123")

// Cancel by AWB
client.Order.Express.Cancel("AWB123456", "Customer request")

// Request pickup (v5)
client.Order.Express.RequestPickupV5(payload)

// Request pickup (v6.1)
client.Order.Express.RequestPickupV61(payload)

---

Order — Instant

// Create instant pickup
client.Order.Instant.Create(payload)

// Find a new driver for an existing order
client.Order.Instant.FindNewDriver("ORDER123")

// Cancel instant order
client.Order.Instant.Cancel("ORDER123")

// Track instant order
client.Order.Instant.Track("ORDER123")

---

Courier

// List available couriers
client.Courier.List()

// Courier groups
client.Courier.Group()

// Courier service detail
client.Courier.Detail("jne")

// Set whitelist services
client.Courier.SetWhitelistServices([]string{"jne_reg", "jne_yes"})

---

Pickup Schedules

client.Pickup.Schedules()

---

Payment

client.Payment.GetPayment("PAY123")

---

Development

go build ./...   # build all packages
go test ./...    # run tests

Documentation

Index

• Constants
• type Client
  • func New(cfg Config) *Client
• type Config
• type Env

Constants

const (
	EnvSandbox    = config.EnvSandbox
	EnvProduction = config.EnvProduction
)

Types

type Client

type Client struct {
	Address      *address.Service
	Courier      *courier.Service
	CoverageArea *coveragearea.Service
	Order        *order.Service
	Payment      *payment.Service
	Pickup       *pickup.Service
	// contains filtered or unexported fields
}

func New

func New(cfg Config) *Client

type Config

type Config = config.Config

type Env

type Env = config.Env