Cek Tarif

Pendahuluan

API Cek Tarif digunakan untuk mendapatkan daftar produk layanan kiriman mana saja yang tersedia dari Ongkirmurah untuk kamu gunakan.

Endpoint

Method Environment URL
POST Production https://api.ongkirmurah.com/v1/get_fee
POST Sandbox https://api.ongkirmurah.com/v1/sandbox/get_fee

Headers

{info} Silakan gunakan token pada akun Anda.

Key Value
Content-Type application/json
Accept application/json
Authorization Bearer token_here

Request Sample

{info} Silakan gunakan data wilayah dari pengecekan tarif untuk mengisikan data wilayah pengirim dan penerima.

Nama Tipe Data Required Contoh Deskripsi
senderSubDistrict string(50) ✔️ Kel. Tambora kelurahan pengirim
senderDistrict string(50) ✔️ Tambora kecamatan pengirim
senderCity string(50) ✔️ Kota Adm. Jakarta Barat kota pengirim
senderProvince string(50) ✔️ Dki Jakarta provinsi pengirim
senderZipCode string(5) ✔️ 11220 kode pos pengirim
receiverSubDistrict string(50) ✔️ Kel. Tambora kelurahan penerima
receiverDistrict string(50) ✔️ Tambora kecamatan penerima
receiverCity string(50) ✔️ Kota Adm. Jakarta Barat kota penerima
receiverProvince string(50) ✔️ Dki Jakarta provinsi penerima
receiverZipCode string(5) ✔️ 11220 kode pos penerima
itemType string ✔️ 0 Tipe Paket
itemValue integer ✔️ 10000 Nilai harga barang dalam Rupiah
length integer ✔️ 10 Dimensi panjang barang dalam sentimeter (cm)
width integer ✔️ 15 Dimensi lebar barang dalam sentimeter (cm)
height integer ✔️ 20 Dimensi tinggi barang dalam sentimeter (cm)
weight integer ✔️ 1000 Berat aktual barang dalam gram (gr)
enableInsurance boolean ✔️ true Opsi penggunaan asuransi kiriman
commodityType string ✖️ ABR036B Tipe Commodity (Opsional, untuk kiriman lion parcel)
codType string ✖️ noncod Tipe COD Opsional untuk melakukan transaksi COD atau Non COD

Tipe Barang

Nilai Deskripsi
0 Surat
1 Paket

Tipe Commodity

Kode Nama
ABR036 Aksesoris & Barang Pribadi
BPI093 Sampel Cairan / Liquid sample (NON DG)
BPI105 Pupuk
ELG150 Electronic Devices Contain Lithium-ION Battery
ELG184 Elektronik & Gadget
KPP029 Parfum
KPP065 Kosmetik - Skin Care (Pelembab/Pembersh Wajah/Serum)
MSO097 Makanan, Minuman, Suplemen & Obat-obatan
PTE049 Pakaian & Tekstil
RMH177 Pelengkapan Rumah
THT017 Tanaman Hidup & Turunan
BPI082 Thinner
BPI117 Bahan Bangunan & Perlengkapan Industri
ORH050 Olahraga & Hobi
VDO001 Surat Berharga Lainnya

Tipe COD

Tipe deskripsi
noncod Kiriman Non COD
gvcod Kiriman COD nilai barang saja
dfod Kiriman COD biaya kirim saja
codplus Kiriman COD nilai barang + biaya kirim

Responses

{success} Berikut contoh dan penjelasan response get_fee sukses.

Nama Tipe Data Contoh Deskripsi
status integer 1 Kode response sukses
message string Sukses Pesan hasil request API
data array - Data dari hasil request
data.*.courier_name string J&T Express Nama kurir yang tersedia
data.*.service_code string jtexpress_ez Kode service dari layanan yang tersedia
data.*.service_name string EZ Nama service dari layanan kurir
data.*.fee integer 7418 Biaya dasar pengiriman
data.*.fee_tax integer 82 Pajak biaya dasar pengiriman
data.*.insurance integer 20 Biaya asuransi
data.*.insurance_tax integer 0 Pajak biaya asuransi
data.*.total_fee integer 7520 Total biaya yang perlu dibayarkan dari deposit Ongkirmurah
data.*.cod_amount integer 0 Nilai COD yang perlu dibayarkan oleh Penerima. Nilai ini sudah termasuk Biaya COD dan pajaknya dan tidak dibayarkan oleh Mitra Ongkirmurah.
data.*.cod_fee integer 0 Nilai biaya COD biaya COD yang tergabung pada nilai COD
data.*.cod_fee_tax integer 0 Biaya PPN dari biaya COD. Biaya ini sudah termasuk pada nilai COD.
data.*.status integer 1 Status produk hasil pengecekan tarif
data.*.message string - Pesan tambahan terkait status produk (mis. alasan tidak tersedia, keterangan dari supplier)
data.*.sla_min string 7 Estimasi minimal kiriman akan sampai pada tujuan. Apabila data tidak ditemukan, maka nilai yang ditampilkan akan berupa "-"
data.*.sla_max string 14 Estimasi maksimal kiriman akan sampai pada tujuan. Apabila data tidak ditemukan, maka nilai yang ditampilkan akan berupa "-"
data.*.sla_type string Hari Satuan waktu yang digunakan untuk estimasi minimal dan maksimal waktu pengiriman. Apabila data tidak ditemukan, maka nilai yang ditampilkan akan berupa "-"

{info} cod_amount, cod_fee, dan cod_fee_tax adalah data seputar COD dan tidak mempengaruhi deposit Mitra.

Status pada objek data

Nilai Deskripsi
0 Layanan tidak aktif / tidak tersedia saat ini.
1 Layanan tersedia dan dapat digunakan (biaya valid).
2 Produk/layanan tidak terpetakan pada sistem (tidak ada mapping ke layanan supplier).
3 Terjadi error saat mengambil data dari supplier/partner ekspedisi.
4 Alamat pengiriman berada di luar jangkauan layanan (out of coverage).
5 Diperlukan kode komoditas (commodity code) untuk menghitung tarif (mis. layanan khusus).
6 Berat aktual di bawah batas minimal yang dapat dikenakan biaya (min chargeable weight).
7 Berat melebihi batas maksimal yang dapat ditangani oleh layanan.
8 Kiriman pilihan tipe COD tidak tersedia

Test Case Sandbox

{info} Silakan gunakan payload dengan kata kunci berikut untuk mendapatkan status yang diharapkan saat menggunakan sandbox. Nilai setiap atribut request yang diperlukan untuk mendapatkan hasil testing dengan status yang diinginkan sama dengan apa yang diberikan pada tabel. Untuk nilai receiver bisa menggunakan data wilayah apapun.

senderSubDistrict senderDistrict senderCity senderProvince senderZipCode status
Kel. Tambora Tambora Kota Adm. Jakarta Barat Dki Jakarta 11220 Sukses
Tambora Tambora Jakarta Barat Dki Jakarta 11220 Sukses
Kel. Sekejati Buahbatu Kota Bandung Jawa Barat 40286 Sukses
Sekejati Buahbatu Bandung Jawa Barat 40286 Sukses
Kel. Pinang Pinang Kota Tangerang Banten 15145 Sukses dengan data kosong
Pinang Pinang Tangerang Banten 15145 Sukses dengan data kosong

Live Testing Sandbox