Mulai

Ringkasan

API Kurir memungkinkan Anda mengecek ongkir dari banyak kurir, membuat order pengiriman, melacak resi, dan mengelola saldo — semuanya lewat REST API yang sederhana.

Semua request menuju gateway https://use.api.co.id dan diautentikasi dengan API key lewat header x-api-co-id. Response selalu JSON dengan struktur yang konsisten.

Alur umum integrasi:

1. Ambil kode lokasi lewat endpoint Kecamatan.
2. Panggil Cek Ongkir untuk mendapat quote_id dan daftar tarif.
3. Buat Order dengan quote_id + kurir yang dipilih.
4. Terima update status lewat Webhooks atau Lacak Pengiriman.

info

COD (bayar di tempat) segera hadir. Untuk saat ini seluruh tarif dan order bersifat non-COD.

Autentikasi

Setiap request harus menyertakan API key pada header x-api-co-id. Request tanpa key yang valid akan ditolak dengan 401.

x-api-co-id: YOUR_API_KEY

API key dibuat dan dikelola di dashboard akun api.co.id. Simpan key di sisi server; jangan menaruhnya di kode front-end atau repositori publik.

Base URL

Semua endpoint menggunakan base URL berikut. Gabungkan dengan path tiap endpoint.

https://use.api.co.id

Contoh: endpoint Cek Ongkir GET /courier/v2/rates berarti https://use.api.co.id/courier/v2/rates.

Format Response

Semua response memiliki amplop JSON yang konsisten:

{
  "is_success": true,
  "message": "OK",
  "data": { ... },
  "paging": { "page": 1, "per_page": 20, "total": 42 }
}

• is_success — true bila request berhasil, false bila error.
• message — pesan singkat berbahasa Indonesia.
• data — payload utama (objek atau array), null saat error.
• paging — hanya muncul pada endpoint berpaginasi (mis. daftar order).

Saat error, periksa kode status HTTP dan message. Lihat Kode Error.

Harga & Biaya

• Cek Ongkir (GET /courier/v2/rates) dikenai biaya Rp 5 per pemanggilan yang berhasil.
• Endpoint /courier/v1/* (kurir, lokasi, alamat, tracking, saldo) gratis.
• Ongkir pengiriman dipotong dari saldo saat Order dibuat, bukan saat cek ongkir.

Biaya cek ongkir dan ongkir order dipotong dari saldo akun. Bila saldo tidak cukup, endpoint mengembalikan 402. Cek saldo lewat endpoint Saldo.