Dokumentasi API Ongkos Kirim

Layanan Ongkos Kirim adalah sebuah service API yang menyediakan informasi terkait ongkos pengiriman dari seluruh Kurir yang ada di Indonesia maupun Internasional, dimana data yang kami sajikan adalah data yang terkait langsung dengan Kurir masing-masing.


Daftar Kurir

Dibawah ini adalah daftar kurir yang tersedia untuk saat ini dan akan terus di-update secara berkala untuk kurir lainnya.

# Kode Kurir Ongkos Kirim Cek Resi
1 jne Jalur Nugraha Ekakurir (JNE) Tersedia Tersedia
2 jnt J&T Express (J&T) Tersedia Tersedia
3 pos POS Indonesia Belum Belum
4 tiki Citra Van Titipan Kilat (TIKI) Tersedia Tersedia
5 lion Lion Parcel (LION) Tersedia Tersedia
6 ninja Ninja Xpress (NINJA) Belum Belum
7 wahana Wahana Prestasi Logistik (WAHANA) Belum Belum
8 sicepat Sicepat Ekspres (SICEPAT) Tersedia Tersedia
9 alfatrex Alfatrex Tersedia Belum
10 pcp PCP Express Tersedia Belum
11 sap SAP Express Tersedia Belum

API Propinsi

Endpoint ini digunakan untuk mengambil data propinsi yang ada di Indonesia.

Berikut adalah informasi yang dapat Anda gunakan untuk melakukan Request

Method URL
GET https://ruangapi.com/api/v1/provinces
Method Wajib Parameter Keterangan
Authorization Header Ya Authorization API Key
GET Tidak id ID Propinsi

Catatan: Apabila ID Propinsi dikosongkan, maka seluruh data propinsi akan ditampilkan


{
    "statusCode": 200,
    "status": "success",
    "message": "",
    "data": {
        "query": {
            "id": "1"
        },
        "results": {
            "id": 1,
            "name": "Bali"
        }
    }
}                                        

API Kota/Kabupaten

Endpoint ini digunakan untuk mengambil data kota/kabupaten yang ada di Indonesia.

Berikut adalah informasi yang dapat Anda gunakan untuk melakukan Request

Method URL
GET https://ruangapi.com/api/v1/cities
Method Wajib Parameter Keterangan
Authorization Header Ya Authorization API Key
GET Ya province ID Propinsi
GET Tidak id ID Kota/Kabupaten
GET Tidak q Query Pencarian By Teks

Catatan:

  • Jika ID Kota/Kabupaten dikosongkan, maka seluruh data Kota/Kabupaten akan ditampilkan
  • Jika q tidak sama dengan kosong, maka parameter id & province akan diabaikan.


{
    "statusCode": 200,
    "status": "success",
    "message": "",
    "data": {
        "query": {
            "id": null,
            "province": "1",
            "q": ""
        },
        "province": {
            "id": 1,
            "name": "Bali"
        },
        "results": [
            {
                "id": 17,
                "province_id": 1,
                "name": "Badung",
                "type": "Kabupaten",
                "postal_code": "80351"
            },
            {
                "id": 32,
                "province_id": 1,
                "name": "Bangli",
                "type": "Kabupaten",
                "postal_code": "80619"
            },
            {
                "id": 94,
                "province_id": 1,
                "name": "Buleleng",
                "type": "Kabupaten",
                "postal_code": "81111"
            },
            {
                "id": 114,
                "province_id": 1,
                "name": "Denpasar",
                "type": "Kota",
                "postal_code": "80227"
            },
            {
                "id": 128,
                "province_id": 1,
                "name": "Gianyar",
                "type": "Kabupaten",
                "postal_code": "80519"
            },
            {
                "id": 161,
                "province_id": 1,
                "name": "Jembrana",
                "type": "Kabupaten",
                "postal_code": "82251"
            },
            {
                "id": 170,
                "province_id": 1,
                "name": "Karangasem",
                "type": "Kabupaten",
                "postal_code": "80819"
            },
            {
                "id": 197,
                "province_id": 1,
                "name": "Klungkung",
                "type": "Kabupaten",
                "postal_code": "80719"
            },
            {
                "id": 447,
                "province_id": 1,
                "name": "Tabanan",
                "type": "Kabupaten",
                "postal_code": "82119"
            }
        ]
    }
}                                        

API Kecamatan

Endpoint ini digunakan untuk mengambil data Kecamatan yang ada di Indonesia.

Berikut adalah informasi yang dapat Anda gunakan untuk melakukan Request

Method URL
GET https://ruangapi.com/api/v1/districts
Method Wajib Parameter Keterangan
Authorization Header Ya Authorization API Key
GET Ya city ID Kota/Kabupaten
GET Tidak id ID Kecamatan
GET Tidak q Query Pencarian By Teks

Catatan:

  • Jika ID Kecamatan dikosongkan, maka seluruh data Kecamatan akan ditampilkan.
  • Jika q tidak sama dengan kosong, maka parameter id & city akan diabaikan.


{
    "statusCode": 200,
    "status": "success",
    "message": "",
    "data": {
        "query": {
            "id": null,
            "city": "1",
            "q": ""
        },
        "city": {
            "id": 1,
            "name": "Aceh Barat",
            "province": "Nanggroe Aceh Darussalam (NAD)"
        },
        "results": [
            {
                "id": 1,
                "name": "Arongan Lambalek"
            },
            {
                "id": 2,
                "name": "Bubon"
            },
            {
                "id": 3,
                "name": "Johan Pahlawan"
            },
            {
                "id": 4,
                "name": "Kaway XVI"
            },
            {
                "id": 5,
                "name": "Meureubo"
            },
            {
                "id": 6,
                "name": "Pante Ceureumen (Pantai Ceuremen)"
            },
            {
                "id": 7,
                "name": "Panton Reu"
            },
            {
                "id": 8,
                "name": "Samatiga"
            },
            {
                "id": 9,
                "name": "Sungai Mas"
            },
            {
                "id": 10,
                "name": "Woyla"
            },
            {
                "id": 11,
                "name": "Woyla Barat"
            },
            {
                "id": 12,
                "name": "Woyla Timur"
            }
        ]
    }
}                                        

API Ongkos Kirim

Endpoint ini digunakan untuk mengambil data Ongkos Kirim yang ada di Indonesia.

Berikut adalah informasi yang dapat Anda gunakan untuk melakukan Request

Method URL
POST https://ruangapi.com/api/v1/shipping
Method Wajib Parameter Keterangan
Authorization Header Ya Authorization API Key
POST Ya origin ID Asal Pengiriman (Kota/Kabupaten)
POST Ya destination ID Tujuan Pengiriman (Kecamatan)
POST Ya weight Berat Barang (gram)
POST Ya courier ID Kurir (Contoh: jne,jnt) Lihat Daftar

Catatan: Apabila lebih dari satu kurir, pisahkan dengan koma.


{
    "statusCode": 200,
    "status": "success",
    "data": {
        "query": {
            "origin": "22",
            "destination": "14",
            "weight": "600",
            "courier": "jnt,jne"
        },
        "origin": {
            "city_id": "22",
            "city_name": "Bandung",
            "province": "Jawa Barat"
        },
        "destination": {
            "district_id": "14",
            "district_name": "Blang Pidie",
            "city": "Aceh Barat Daya",
            "province": "Nanggroe Aceh Darussalam (NAD)"
        },
        "results": [
            {
                "courier": "JNT",
                "service": "EZ",
                "description": "",
                "estimate": "",
                "cost": "61000"
            },
            {
                "courier": "JNE",
                "service": "JTR",
                "description": "Tiki Jalur Nugraha Ekakurir",
                "estimate": "8-9",
                "cost": "125000"
            },
            {
                "courier": "JNE",
                "service": "JTR250",
                "description": "Tiki Jalur Nugraha Ekakurir",
                "estimate": "8-9",
                "cost": "2700000"
            },
            {
                "courier": "JNE",
                "service": "JTR<150",
                "description": "Tiki Jalur Nugraha Ekakurir",
                "estimate": "8-9",
                "cost": "2200000"
            },
            {
                "courier": "JNE",
                "service": "JTR>250",
                "description": "Tiki Jalur Nugraha Ekakurir",
                "estimate": "8-9",
                "cost": "4100000"
            },
            {
                "courier": "JNE",
                "service": "OKE",
                "description": "Tiki Jalur Nugraha Ekakurir",
                "estimate": "3-6",
                "cost": "47000"
            },
            {
                "courier": "JNE",
                "service": "REG",
                "description": "Tiki Jalur Nugraha Ekakurir",
                "estimate": "2-3",
                "cost": "52000"
            }
        ]
    }
}                                        

API Waybill (Cek Resi)

Endpoint ini digunakan untuk mengambil data detail resi dari masing-masing Ekspedisi.

Berikut adalah informasi yang dapat Anda gunakan untuk melakukan Request

Method URL
POST https://ruangapi.com/api/v1/waybill
Method Wajib Parameter Keterangan
Authorization Header Ya Authorization API Key
POST Ya waybill Nomor Resi
POST Ya courier Kode Ekspedisi, Lihat Daftar

Catatan: Pencarian Nomor Resi Hanya Bisa 1 Kurir.


{
    "statusCode": 200,
    "status": "success",
    "data": {
        "waybill": {
            "waybill_number": "JD0068856818",
            "waybill_date": "2020-04-21",
            "waybill_time": "10:05:16"
        },
        "delivery_status": {
            "status": "DELIVERED",
            "pod_name": "JAINAL",
            "pod_date": "2020-04-21",
            "pod_time": "22:59:26"
        },
        "courier": {
            "code": "jnt",
            "name": "J&T Express",
            "service_code": ""
        },
        "details": [
            {
                "shipping_code": "5",
                "shipping_description": "Terkirim",
                "shipping_date": "2020-04-21",
                "shipping_time": "22:59:26",
                "city_name": "PEMATANG SIANTAR"
            },
            {
                "shipping_code": "4",
                "shipping_description": "Sedang Diantar",
                "shipping_date": "2020-04-21",
                "shipping_time": "11:48:52",
                "city_name": "PEMATANG SIANTAR"
            },
            {
                "shipping_code": "1",
                "shipping_description": "Telah Diambil",
                "shipping_date": "2020-04-21",
                "shipping_time": "10:05:16",
                "city_name": "PEMATANG SIANTAR"
            }
        ]
    }
}