Dokumentasi API Akun Starter


Dokumentasi ini menjelaskan cara mengakses layanan API RajaOngkir untuk akun Starter. Akun Starter merupakan akun gratis dengan fitur pengecekan ongkos kirim (ongkir) untuk kurir JNE, POS Indonesia, dan TIKI. Jika Anda membutuhkan fitur lain seperti lacak paket JNE, ongkos kirim internasional, dan ongkos kirim sampai level kecamatan, silakan upgrade akun Anda.

Province


Ringkasan

Method "province" digunakan untuk mendapatkan daftar propinsi yang ada di Indonesia.

Request

Method URL
GET http://api.rajaongkir.com/starter/province
Method Parameter Wajib Tipe Keterangan
GET/HEAD key Ya String API Key
GET/HEAD android-key Tidak String Identitas aplikasi Android
GET/HEAD ios-key Tidak String Identitas aplikasi iOS
GET id Tidak String ID propinsi

Catatan:

  • Jika ID propinsi kosong maka akan menampilkan semua propinsi di Indonesia.
  • Parameter "android-key" wajib disertakan jika Anda mengaktifkan perujuk untuk aplikasi Android.
  • Parameter "ios-key" wajib disertakan jika Anda mengaktifkan perujuk untuk aplikasi iOS.

Response

Komponen Tipe Keterangan
id String ID propinsi
code Int Code status response
description String Penjelasan dari kode status
province_id String ID propinsi
province_name String Nama propinsi

City


Ringkasan

Method "city" digunakan untuk mendapatkan daftar kota/kabupaten yang ada di Indonesia.

Request

Method URL
GET http://api.rajaongkir.com/starter/city
Method Parameter Wajib Tipe Keterangan
GET/HEAD key Ya String API Key
GET/HEAD android-key Tidak String Identitas aplikasi Android
GET/HEAD ios-key Tidak String Identitas aplikasi iOS
GET id Tidak String ID kota/kabupaten
GET province Tidak String ID propinsi

Catatan:

  • Jika ID kota dan ID propinsi kosong, maka akan menampilkan semua kota/kabupaten di Indonesia.
  • Parameter "android-key" wajib disertakan jika Anda mengaktifkan perujuk untuk aplikasi Android.
  • Parameter "ios-key" wajib disertakan jika Anda mengaktifkan perujuk untuk aplikasi iOS.

Response

Komponen Tipe Keterangan
id String ID kota/kabupaten
code Int Code status response
description String Penjelasan dari kode status
province_id String ID propinsi
city_id String ID kota/kabupaten
province String Nama propinsi
type String Jenis Daerah Tingkat II. Berisi "Kota" atau "Kabupaten"
city_name String Nama kota/kabupaten
postal_code String Kodepos kota/kabupaten

Cost


Ringkasan

Method “cost” digunakan untuk mengetahui tarif pengiriman (ongkos kirim) dari dan ke kota tujuan tertentu dengan berat tertentu pula.

Request

Method URL
POST http://api.rajaongkir.com/starter/cost
Method Parameter Wajib Tipe Keterangan
POST/HEAD key Ya String API Key
POST/HEAD android-key Tidak String Identitas aplikasi Android
POST/HEAD ios-key Tidak String Identitas aplikasi iOS
POST origin Ya String ID kota atau kabupaten asal
POST destination Ya String ID kota atau kabupaten tujuan
POST weight Ya Int Berat kiriman dalam gram
POST courier Ya String Kode kurir: jne, pos, tiki.

Catatan:

  • Parameter "android-key" wajib disertakan jika Anda mengaktifkan perujuk untuk aplikasi Android.
  • Parameter "ios-key" wajib disertakan jika Anda mengaktifkan perujuk untuk aplikasi iOS.

Response

Komponen Tipe Keterangan
origin String ID kota/kabupaten asal
destination String ID kota/kabupaten tujuan
weight Int Berat kiriman
courier String Kode kurir yang dipakai
code Int Kode status response
description String Penjelasan kode status
city_id String ID kota atau kabupaten
province_id String ID propinsi
province String Propinsi dimana kota atau kabupaten berada
type String Jenis Daerah Tingkat II
city_name String Nama kota atau kabupaten
postal_code String Kodepos kota atau kabupaten
code String Bagian dari results yang merupakan kode kurir
name String Nama kurir
service String Nama layanan yang digunakan dalam pengiriman
description String Deskripsi dari layanan pengiriman terkait
value Int Tarif pengiriman (ongkos kirim)
etd String Perkiraan waktu pengiriman (dalam hari).
note String Catatan terkait tarif pengiriman
Top