KiriminAja Developer Documentation

Hubungi kami untuk mendapatkan kredensial untuk sandbox dan production. Semua paket melalui sandbox mungkin dibatalkan sewaktu-waktu. Respon antara sandbox dan production sama persis, hanya keakuratan data yang berbeda.

Otomatisasi seperti callback, pengecekan finish tidak akan berjalan di sandbox.

Kode token production akan berbeda dengan sandbox. Kami akan mencatat alamat IP address anda ketika menggunakan production.

URL Staging

DISCLAIMER! Selalu gunakan Headers berikut untuk setiap melakukan akses ke API.

Authorization Bearer {{token}}
Content-Type application/json
Accept application/json

📖 Origin & Destination

[POST] Provinsi

Contoh Response

[POST] Kabupaten/Kota

Parameter

Field Data Type Mandatori Deskripsi
provinsi_id Integer Y Provinsi ID

Contoh Request

[POST] Kecamatan

Parameter

Field Data Type Mandatori Deskripsi
kabupaten_id Integer Y Kabupaten ID

Contoh Request

📖 [POST] Shipping Price

Parameter

Field Data Type Mandatori Deskripsi
origin Integer Y ID dari kecamatan_id pengirim
destination Integer Y ID dari kecamatan_id penerima
weight Integer Y Akumulasi berat paket dalam gram (berat paket). * Catatan ada di bawah.
insurance Integer Y Diisi jika paket membutuhkan asuransi
item_value Integer Y Nominal harga barang yang dikirim
courier string or array N Pilihan kurir untuk jne,jnt,sicepat,sap,jx. Secara default akan ditampilkan keseluruhan

Catatan

  1. Data origin akan disesuaikan ketersediaan gudang KiriminAja di area tersebut
  2. Perhitungan Berat aktual dan Volume (Panjang x Lebar x Tinggi)/6000. Diambil mana yang lebih besar.
  3. Field cod jika true maka available untuk create paket cod.
  4. Field drop jika true maka available untuk service drop off dan pickup. Jika field drop false maka hanya pickup saja.

Contoh Request

📖 Pickup

[POST] Pickup Schedules

Jadwal pickup tersedia 3 hari. Diambil dari Jam request saat ini.

Contoh Result

[POST] Request Pickup

Pickup Section
Field Data Type Mandatori Deskripsi
longitude double Y Longitude penjemputan
latitude double Y Latitude penjemputan
address string(200) Y Alamat lengkap
phone string(15) Y Nomor telepon menggunakan format angka 0
name string(50) Y Nama pengirim paket
zipcode string(6) Y Kode pos pengirim
provinsi_id integer Y Provinsi id pengirim
kabupaten_id integer Y Kabupaten id pengirim
kecamatan_id integer Y Kecamatan id pengirim
packages array Y Lihat penyusunan list paket berikut
schedule string Y Lihat bagian #Pickup Schedules
platform_name string N Nama aplikasi anda ketika menerima notifikasi, secara default adalah mitra
Package Section
Field Data Type Mandatori Deskripsi
order_id string(20) Y Order ID, harus memiliki prefix berupa string
destination_name string(50) Y Nama penerima
destination_phone string(15) Y Nomor telepon diawali dengan angka 0
destination_address string(200) Y Alamat penerima
destination_kecamatan_id int Y Kecamatan penerima
weight int Y Berat paket dalam gram
width int Y cm
length int Y cm
qty int N Jumlah barang dalam paket, akan terisi 1 jika kosong
height int Y cm
item_value int Y Nilai barang secara keseluruhan
shipping_cost int Y Biaya pengiriman, see # Shipping Price section
service string Y Available jne,jnt,jtl. See Pricing Section below
insurance_amount string N The value of insurance is 0.2% of the value of the goods and is rounded up according to the agreement * Catatan di bawah
service_type string Y The service type, like EZ, REG, CTC, OKE, etc (see shipping price section)
add_cost int Y COD FEE, fill 0 if not an COD transaction * Catatan di bawah
cod int Y COD PRICE * Catatan di bawah
package_type_id int Y Tipe paket tersedia untuk sementara 1
item_name string(50) Y Isi paket
discount double N Presentase dari nilai barang
discount_amount integer N Nilai diskon, jika field discount diisi maka field ini wajib diisi.

Catatan Package Insurance & COD

Nilai add_cost dan insurance_amount dihitung berdasarkan kesepakatan sebelum proses integrasi API dengan kami.

Untuk mempercepat request pickup, kami hanya melakukan pengecekan ulang biaya pengiriman barang ketika divalidasi oleh driver, bukan melalui API.

COD Fee Calculation

Param Amount
item_value 20000
shipping_cost 15000
insurance_amount 500
cod_fee 4.3% (cek di halaman syarat & ketentuan)
-------- +++++++
total 35500
add_cost total * cod_fee and rounded up to 100 (ex : 1.020 to 1.100)
cod total + cod_fee

Insurance Amount Calculation

Param Amount
item_value 20000
percentage 0.2% (cek di halaman syarat & ketentuan)
-------- ***
insurance_amount item_value * percentage and rounded up to 100 (ex : 1.020 to 1.100)

Contoh Request

[POST] Payment QRIS

Parameter

Field Data Type Mandatori Deskripsi
pickup_number string Y Pickup Number

Contoh Request

[POST] List Pickup

Parameter

Field Data Type Mandatori Deskripsi
type Enum(pickup,return) N Enum, hanya bisa pickup atau return
status Enum(new, pending, picked, finish, cancel) N Mencari data pickup berdasarkan status.
period String(32) N Gunakan format dd/mm/YYYY - dd/mm/YYYY
search String N Untuk pencarian pickup_number

Contoh Request

[POST]Cancel Pickup

Parameter

Field Data Type Mandatori Deskripsi
pickup_number string(15) Y Nomor pickup
type tinyint(1) N TypeDefault 1

Contoh Request

4. [POST] Tracking

Parameter

Field Data Type Mandatori Deskripsi
order_id String(20) Y Nomor paket atau nomor resi paket

Data tracking diambil dari 2 sumber, yaitu KiriminAja dan pihak expedisi yang digabungkan menjadi satu.

Contoh Request

📖 Callback

ENDPOINT yang anda set dibawah adalah url yang diset ke database kami. Tolong persiapkan untuk memproses data kami sesuai method dibawah. Segala kesalahan di pihak anda bukan tanggungjawab kami. Kami hanya menyimpan respon error dari http response_code, jika 200 / sukses kami anggap berhasil.

[POST] Callback Call

{{callback_endpoint}}

Info

Format tanggal wajib YYYY-MM-DD HH:i:s (PHP date format) contoh seperti dibawah. Silahkan sesuaikan dengan bahasa program yang anda gunakan.

Parameter Type Description
method String Kami akan menulis nama method mengikuti data yang dikirimkan (plural atau singular)
data Mixed Kami akan menggunakan data sesuai method

Available Method

Method Nouns Description
processed_packages Plural Konfirmasi pemrosesan nomor AWB
shipped_packages Plural Konfirmasi paket yang telah dibawa pihak expedisi
finished_packages Plural Konfirmasi paket yang telah diterima oleh penerima
returned_packages Plural Paket yang telah mendapat informasi pengembalian dari expedisi
rejected_packages Plural Paket yang ditolak oleh kami
corrected_packages Plural Daftar paket yang telah melewati proses validasi, tapi terjadi perubahan biaya kirim. Paket tetap dikirim sesuai kesepakatan dengan pengirim paket dan penerima paket. The list contains order_id, correction_code (see correction code below), correction_amount, reason, shipping_cost (New shipping cost), add_cost (New add_cost), cod (New cod amount)
return_finished_packages Plural List paket yang telah sampai di destinasi pengembalian

Package Correction Code

Code Description
1 If the actual postage value is greater than the postage when the package is created
2 Nilai ongkos kirim aktual lebih kecil dari nilai yang ditagihkan di awal

Contoh Body Raw

[POST]Set Callback Url

Alamat callback harus memiliki catatan A atau AAAA yang valid. Kami akan menolak URL yang belum dapat diakses.

Untuk saat ini, hanya satu callback / webhook yang diperbolehkan. Maka harap perhatikan dan persiapkan baik-baik.

Method yang kami kirimkan adalah POST. Segala bentuk kesalahan didalam sistem anda bukan tanggungjawab kami.

Contoh Request