Dokumentasi API Akun Pro
Dokumentasi ini menjelaskan cara mengakses layanan API RajaOngkir untuk akun Pro. Akun Pro merupakan akun premium RajaOngkir dengan fitur paling lengkap termasuk pengecekan ongkos kirim sampai level kecamatan.
Province
Ringkasan
Method "province" digunakan untuk mendapatkan daftar propinsi yang ada di Indonesia.
Request
| Method | URL |
| GET | https://pro.rajaongkir.com/api/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 | https://pro.rajaongkir.com/api/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 |
Subdistrict
Ringkasan
Method "subdistrict" digunakan untuk mendapatkan daftar kecamatan yang ada di Indonesia.
Request
| Method | URL |
| GET | https://pro.rajaongkir.com/api/subdistrict |
| 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 | city | Ya | String | ID kota/kabupaten |
| GET | id | Tidak | String | ID kecamatan |
Catatan:
- Jika ID kecamatan kosong, maka akan menampilkan semua kecmatan pada kabupaten/kota terkait. Jika ID kecamatan diisi, maka akan menampilkan detil kecamatan.
- 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 |
| city | String | ID kota/kabupaten |
| code | Int | Code status response |
| description | String | Penjelasan dari kode status |
| subdistrict_id | String | ID kecamatan |
| province_id | String | ID propinsi |
| province | String | Nama propinsi |
| city_id | String | ID kota/kabupaten |
| city | String | Nama kota/kabupaten |
| type | String | Jenis Daerah Tingkat II. Berisi "Kota" atau "Kabupaten" |
| subdistrict_name | String | Nama kecamatan |
Cost
Ringkasan
Method “cost” digunakan untuk mengetahui tarif pengiriman (ongkos kirim) dari dan ke kecamatan tujuan tertentu dengan berat tertentu pula.
Request
| Method | URL |
| POST | https://pro.rajaongkir.com/api/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/kabupaten atau kecamatan asal |
| POST | originType * | Ya | String | Tipe origin: 'city' atau 'subdistrict'. |
| POST | destination | Ya | String | ID kota/kabupaten atau kecamatan tujuan |
| POST | destinationType ** | Ya | String | Tipe destination: 'city' atau 'subdistrict'. |
| POST | weight | Ya | Int | Berat kiriman dalam gram |
| POST | courier | Ya | String | Kode kurir: jne, pos, tiki, rpx, pandu, wahana, sicepat, jnt, pahala, sap, jet, indah, dse, slis, first, ncs, star, ninja, lion, idl, rex, ide, sentral, anteraja, jtl. |
| POST | length | Tidak | Number | Dimensi panjang paket kiriman (cm) |
| POST | width | Tidak | Number | Dimensi lebar paket kiriman (cm) |
| POST | height | Tidak | Number | Dimensi tinggi paket kiriman (cm) |
| POST | diameter | Tidak | Number | Dimensi diameter paket kiriman (cm) |
Catatan:
- Parameter "courier" wajib diisi. Anda juga bisa menggabungkan kurir dengan tanda ":", misal "jne:pos:tiki" untuk mendapatkan info ongkir ketiga kurir tersebut sekaligus dalam sekali request.
- Parameter "android-key" wajib disertakan jika Anda mengaktifkan perujuk untuk aplikasi Android.
- Parameter "ios-key" wajib disertakan jika Anda mengaktifkan perujuk untuk aplikasi iOS.
- Penggunaan ongkos kirim dimensi sementara hanya berlaku untuk POS Indonesia
- * Gunakan originType 'city' jika ID yang Anda pakai di 'origin' merupakan ID kota/kabupaten. Namun jika Anda menggunakan ID kecamatan pada 'origin' maka gunakan 'subdistrict' pada 'originType'.
- ** Gunakan destinationType 'city' jika ID yang Anda pakai di 'destination' merupakan ID kota/kabupaten. Namun jika Anda menggunakan ID kecamatan pada 'destination' maka gunakan 'subdistrict' pada 'destinationType'.
- Penggunaan 'originType' dan 'destinationType' ini sangat berguna jika Anda ingin mengkombinasikan pengecekan ongkir. Misal dari 'kota ke kecamatan', 'kecamatan ke kecamatan', atau 'kota ke kota'.
Response
| Komponen | Tipe | Keterangan |
| origin | String | ID kota/kabupaten atau kecamatan asal |
| originType | String | Tipe origin |
| destination | String | ID kota/kabupaten atau kecamatan tujuan |
| destinationType | String | Tipe destination |
| 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 |
| subdistrict_id | String | ID kecamatan |
| subdistrict_name | String | Nama kecamatan |
| 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 |
InternationalOrigin
Ringkasan
Method "internationalOrigin" digunakan untuk mendapatkan daftar/nama kota yang mendukung pengiriman internasional.
Request
| Method | URL |
| GET | https://pro.rajaongkir.com/api/v2/internationalOrigin |
| 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 yang mendukung pengiriman internasional 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 |
InternationalDestination
Ringkasan
Method "internationalDestination" digunakan untuk mendapatkan daftar/nama negara tujuan pengiriman internasional.
Request
| Method | URL |
| GET | https://pro.rajaongkir.com/api/v2/internationalDestination |
| 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 negara |
Catatan:
- Jika ID negara kosong, maka akan menampilkan semua negara tujuan pengiriman internasional.
- 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 negara |
| code | Int | Code status response |
| description | String | Penjelasan dari kode status |
| country_id | String | ID negara |
| country_name | String | Nama negara |
InternationalCost
Ringkasan
Method “internationalCost” digunakan untuk mengetahui tarif pengiriman (ongkos kirim) internasional dari kota-kota di Indonesia ke negara tujuan di seluruh dunia.
Request
| Method | URL |
| POST | https://pro.rajaongkir.com/api/v2/internationalCost |
| 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 negara tujuan |
| POST | weight | Ya | Int | Berat kiriman dalam gram |
| POST | courier | Ya | String | Kode kurir: pos, slis, expedito, ray. |
| POST | length | Tidak | Number | Dimensi panjang paket kiriman |
| POST | width | Tidak | Number | Dimensi lebar paket kiriman |
| POST | height | Tidak | Number | Dimensi tinggi paket kiriman |
Catatan:
- Parameter "courier" wajib diisi. Anda juga bisa menggabungkan kurir dengan tanda ":", misal "pos:tiki" untuk mendapatkan info ongkir kedua kurir tersebut sekaligus dalam sekali request.
- 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 negara 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 |
| country_id | String | ID negara tujuan |
| country_name | String | Nama negara tujuan |
| code | String | Bagian dari results yang merupakan kode kurir |
| name | String | Nama kurir |
| service | String | Nama layanan yang digunakan dalam pengiriman |
| cost | Decimal | Tarif layanan |
| currency | String | Jenis mata uang: IDR atau USD. Jika mata uang USD maka akan ada informasi tambahan currency di response JSON. |
| etd | String | Estimasi waktu pengiriman (jika ada) |
Currency
Ringkasan
Method "currency" digunakan untuk mendapatkan informasi nilai tukar rupiah terhadap US dollar.
Request
| Method | URL |
| GET | https://pro.rajaongkir.com/api/currency |
| 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 |
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 |
| code | Int | Code status response |
| description | String | Penjelasan dari kode status |
| value | Integer | Nilai kurs mata uang rupiah terhadap US Dollar |
| last_update | String | Terakhir nilai kurs rupiah di-update |
| source_name | String | Nama sumber pengambilan data kurs rupiah |
| source_link | String | Tautan sumber pengambilan data kurs rupiah |
Waybill
Ringkasan
Method “waybill” untuk digunakan melacak/mengetahui status pengiriman berdasarkan nomor resi.
Request
| Method | URL |
| POST | https://pro.rajaongkir.com/api/waybill |
| 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 | waybill | Ya | String | Nomor resi JNE |
| POST | courier | Ya | String | Kode kurir: pos, wahana, jnt, sap, sicepat, jet, dse, first, ninja, lion, idl, rex, ide, sentral, anteraja, jtl, star |
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 |
| waybill | String | Nomor resi pengiriman yang diinputkan |
| courier | String | Kode kurir yang diinputkan |
| code | Int | Kode status response |
| description | String | Penjelasan kode status |
| delivered | Boolean | Status apakah sudah terkirim, 'true' jika terkirim, 'false' jika belum. |
| courier_code | String | Kode kurir |
| courier_name | String | Nama kurir |
| waybill_number | String | Nomor resi pengiriman |
| service_code | String | Jenis layanan pengiriman yang dipakai |
| waybill_date | Date | Tanggal pengiriman |
| shipper_name | String | Nama pengirim |
| receiver_name | String | Nama penerima |
| origin | String | Kota asal pengiriman |
| destination | String | Kota tujuan pengiriman |
| waybill_time | Time | Waktu/Jam pengiriman |
| weight | Number | Berat kiriman |
| shipper_address1 | String | Alamat lengkap pengirim. Baris 1 |
| shipper_address2 | String | Alamat lengkap pengirim. Baris 2 |
| shipper_address3 | String | Alamat lengkap pengirim. Baris 3 |
| shipper_city | String | Kota pengirim |
| receiver_address1 | String | Alamat lengkap penerima. Baris 1 |
| receiver_address2 | String | Alamat lengkap penerima. Baris 2 |
| receiver_address3 | String | Alamat lengkap penerima. Baris 3 |
| receiver_city | String | Kota penerima |
| status | String | Status pengiriman. Bisa berupa "DELIVERED", "ON PROCESS", dsb. |
| pod_receiver | String | Proof of Delivery receiver. Penerima paket kiriman. |
| pod_date | Date | Tanggal paket kiriman diterima |
| pod_time | Time | Waktu/Jam paket kiriman diterima |
| manifest | Array | Manifest merupakan riwayat pengiriman paket. Value bisa berupa array atau 'null' |
| manifest_code | String | Kode riwayat pengiriman |
| manifest_description | String | Penjelasan mengenai kode manifest |
| manifest_date | Date | Tanggal manifest |
| manifest_time | String | Waktu/jam manifest |
| city_name | String | Nama kota terkait riwayat pengiriman |