API Tambah Transaksi digunakan untuk memesan layanan pengiriman dari alamat pengirim ke alamat tujuan yang diberikan pada request.
| Method | Environment | URL |
|---|---|---|
| POST | Production | https://api.ongkirmurah.com/v1/add_transaction |
| POST | Sandbox | https://api.ongkirmurah.com/v1/sandbox/add_transaction |
{info} Silakan gunakan token pada akun Anda.
| Key | Value |
|---|---|
| Content-Type | application/json |
| Accept | application/json |
| Authorization | Bearer token_here |
| Nama | Tipe Data | Required | Contoh | Deskripsi |
|---|---|---|---|---|
| orderId | string(20) |
✖️ | M100000001 | Nomor unik transaksi yang dibuat oleh mitra, digunakan sebagai nomor referensi transaksi (Opsional) |
| serviceCode | string |
✔️ | jtexpress_ez | Kode layanan pengiriman yang ada pada cek tarif |
| senderName | string(100) |
✔️ | John Doe | Nama pengirim |
| senderAddress | string(200) |
✔️ | Jl alamat pengirim | Detail alamat pengirim |
| senderPhone | string(20) |
✔️ | 08000000001 | Nomor telepon pengirim |
| 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 |
| receiverName | string(100) |
✔️ | Jane Doe | Nama penerima |
| receiverAddress | string(200) |
✔️ | Jl alamat penerima | Detail alamat penerima |
| receiverPhone | string(20) |
✔️ | 08000000002 | Nomor telepon penerima |
| 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 |
| customerName | string(100) |
✖️ | Mark Doe | Nama kustomer untuk ditampilkan pada resi sebagai nama pengirim (Opsional) |
| customerPhone | string(20) |
✖️ | 08000000003 | Nomor telepon kustomer untuk ditampilkan pada resi sebagai nomor telepon pengirim (Opsional) |
| itemName | string(200) |
✔️ | Laptop | Nama barang yang dikirimkan |
| itemType | string |
✔️ | 1 | Tipe barang |
| 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 paket dalam gram (gr) |
| itemValue | integer |
✔️ | 10000 | Nilai barang dalam Rupiah |
| enableInsurance | boolean |
✔️ | false | Opsi asuransi paket |
| webhook_url | string |
✖️ | https://your-webhook-url.com/callback | URL webhook kustom untuk transaksi ini. Jika diisi, akan menimpa URL webhook default merchant. |
| commodityType | string |
✖️ | ABR036B | Tipe Commodity (Opsional, untuk kiriman lion parcel) |
| senderGeoloc | string |
✖️ | -6.21462, 106.84513 | Geolokasi pengirim dengan format [latitude, longitude] (Opsional, untuk kiriman lion parcel) |
| codType | string |
✖️ | noncod | Tipe COD Optional untuk melakukan transaksi COD. (Default noncod) |
| 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 | deskripsi |
|---|---|
| noncod | Kiriman Non COD |
| gvcod | Kiriman COD nilai barang saja |
| dfod | Kiriman COD biaya kirim saja |
| codplus | Kiriman COD nilai barang + biaya kirim |
{success} Berikut contoh dan penjelasan response
add_transactionsukses.
| Nama | Tipe Data | Contoh | Deskripsi |
|---|---|---|---|
| status | integer |
1 | Kode response sukses |
| message | string |
"Sukses" | Pesan hasil request API |
| data | object |
- | Data dari hasil request |
| data.awb_no | string |
JTE012345678901 | Nomor resi paket |
| data.ref_id | string |
1712368141232 | Nomor Ref ID transaksi Ongkirmurah |
| data.status | integer |
1 | Status transaksi pada layanan Ongkirmurah |
| data.fee | integer |
7418 | Biaya dasar layanan pengiriman transaksi |
| data.fee_tax | integer |
82 | Pajak biaya dasar layanan pengiriman transaksi |
| data.insurance | integer |
0 | Biaya asuransi |
| data.insurance_tax | integer |
0 | Pajak biaya asuransi |
| data.total_fee | integer |
7500 | Total biaya transaksi pemesanan kiriman |
| data.deposit | integer |
10000 | Deposit mitra setelah transaksi berhasil |
{danger.fa-close} Berikut contoh dan penjelasan response
add_transactiongagal.
| Nama | Tipe Data | Contoh | Deskripsi |
|---|---|---|---|
| status | integer |
2 | Kode response sukses |
| message | string |
Gagal | Pesan hasil request API |
| data | object |
- | Data dari hasil request |
| data.ref_id | string |
1712368141232 | Nomor Ref ID transaksi Ongkirmurah |
| data.status | integer |
2 | Status transaksi pada layanan Ongkirmurah |
{info} Silakan gunakan payload dengan kata kunci berikut untuk mendapatkan status yang diharapkan saat menggunakan sandbox. Nilai kata kunci yang diperlukan untuk mendapatkan hasil testing perlu sama dengan apa yang diberikan.
serviceCode |
senderPhone |
keterangan |
|---|---|---|
| jtexpress_ez | 08000000001 | Sukses dengan status paket menunggu pickup. Pesanan dapat dibatalkan. |
| jtexpress_ez | 08000000002 | Sukses ketika cek status paket sudah dipickup dan sedang diproses. Pesanan tidak dapat dibatalkan. |
| jtexpress_ez | 08000000003 | Sukses ketika cek status paket sedang diantar ke tempat tujuan. Pesanan tidak dapat dibatalkan. |
| jtexpress_ez | 08000000004 | Sukses ketika cek status paket sudah sampai tujuan. Pesanan tidak dapat dibatalkan. |
| jtexpress_ez | 08000000005 | Sukses ketika cek status paket akan dikembalikan ke pengirim. Pesanan tidak dapat dibatalkan. |
| jtexpress_ez | 08000000009 | Transaksi gagal. Pesanan tidak dapat dibatalkan. |
| jneexpress_reg | 08000000001 | Sukses dengan status paket menunggu pickup. Pesanan dapat dibatalkan. |
| jneexpress_reg | 08000000002 | Sukses ketika cek status paket sudah dipickup dan sedang diproses. Pesanan tidak dapat dibatalkan. |
| jneexpress_reg | 08000000003 | Sukses ketika cek status paket sedang diantar ke tempat tujuan. Pesanan tidak dapat dibatalkan. |
| jneexpress_reg | 08000000004 | Sukses ketika cek status paket sudah sampai tujuan. Pesanan tidak dapat dibatalkan. |
| jneexpress_reg | 08000000005 | Sukses ketika cek status paket akan dikembalikan ke pengirim. Pesanan tidak dapat dibatalkan. |
| jneexpress_reg | 08000000009 | Transaksi gagal. Pesanan tidak dapat dibatalkan. |