Laporan Transaksi Pengiriman

Pendahuluan

API Laporan Transaksi Pengiriman digunakan untuk mendapatkan riwayat pesanan pengiriman dalam jarak tanggal yang berikan.

Endpoint

Method Environment URL
GET Production https://api.ongkirmurah.com/v1/report/transaction
GET Sandbox https://api.ongkirmurah.com/v1/sandbox/report/transaction

Headers

{info} Silakan gunakan token pada akun Anda.

Key Value
Accept application/json
Authorization Bearer token_here

Query Parameter Sample

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

Nama Tipe Data Required Contoh Deskripsi
startDate string ✔️ 2024-11-01 Tanggal mulai filter laporan transaksi dengan jarak 180 hari dengan endDate. Silakan gunakan format Y-m-d
endDate string ✔️ 2024-11-06 Tanggal akhir filter laporan transaksi yang diinginkan. Silakan gunakan format Y-m-d
status string ✔️ 'all' Pilihan status: all, pending, success, failed, cancel.
perPage integer ➖ 10 Jumlah data per halaman yang diinginkan (default: 10)
page integer ➖ 1 Halaman data yang diinginkan

{success} Berikut contoh url dengan query parameter yang sesuai.
https://api.ongkirmurah.com/v1/sandbox/report/transaction?startDate=2024-11-01&endDate=2024-11-06&status=all

Responses

{success} Berikut contoh dan penjelasan response report/transaction sukses.

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.data array - Data yang ada pada halaman yang diinginkan
data.data.*.awb string JTE012345678901 Nomor resi paket
data.data.*.ref_id string 1712368141232 Nomor Ref ID transaksi Ongkirmurah
data.data.*.service_code string jtexpress_ez Kode layanan yang digunakan untuk transaksi
data.data.*.service_name string EZ Nama layanan pengiriman untuk dari kode service saat transaksi
data.data.*.courier_name string J&T Express Nama kurir ekspedisi dari kode layanan transaksi
data.data.*.status integer 1 Status transaksi pada layanan Ongkirmurah
data.data.*.sender_name string John Doe Nama pengirim
data.data.*.sender_address string Jl Alamat pengirim Detail alamat pengirim
data.data.*.sender_phone string 08000000001 No telpon pengirim
data.data.*.sender_subdistrict string Kel. Tambora Nama kelurahan pengirim
data.data.*.sender_district string Tambora Nama kecamatan pengirim
data.data.*.sender_city string Kota Adm. Jakarta Barat Nama kota pengirim
data.data.*.sender_province string Dki Jakarta Nama provinsi pengirim
data.data.*.sender_zip_code string 11220 Kode pos pengirim
data.data.*.receiver_name string Jane Doe Nama penerima
data.data.*.receiver_address string Jl Alamat penerima Detail alamat penerima
data.data.*.receiver_phone string 08000000002 No telpon penerima
data.data.*.receiver_subdistrict string Kel. Tambora Nama kelurahan penerima
data.data.*.receiver_district string Tambora Nama kecamatan penerima
data.data.*.receiver_city string Kota Adm. Jakarta Barat Nama kota penerima
data.data.*.receiver_province string Dki Jakarta Nama provinsi penerima
data.data.*.receiver_zip_code string 11220 Kode pos penerima
data.data.*.item_name string Nama barang Nama barang yang dikirim
data.data.*.item_type string 1 Tipe barang
data.data.*.item_length integer 10 Dimensi panjang barang dalam sentimeter (cm)
data.data.*.item_width integer 15 Dimensi lebar barang dalam sentimeter (cm)
data.data.*.item_height integer 20 Dimensi tinggi barang dalam sentimeter (cm)
data.data.*.item_weight integer 1000 Berat barang dalam gram (gr)
data.data.*.item_value integer 10000 Harga barang dalam Rupiah
data.data.*.fee integer 7418 Biaya layanan pengiriman dalam Rupiah
data.data.*.fee_tax integer 82 Pajak biaya layanan pengiriman dalam Rupiah
data.data.*.insurance integer 0 Biaya asuransi pengiriman dalam Rupiah
data.data.*.insurance_tax integer 0 Pajak biaya asuransi pengiriman dalam Rupiah
data.data.*.total_fee integer 7500 Total biaya pengiriman dalam Rupiah
data.data.*.cod_type string noncod Tipe COD
data.data.*.cod_amount integer 0 Biaya yang dibayarkan oleh penerima
data.data.*.cod_fee integer 0 Biaya layanan COD
data.data.*.cod_fee_tax integer 0 Biaya pajak layanan COD
data.data.*.created_at string 2024-11-01 17:34:11 Datetime dari terbuatnya transaksi
data.data.*.updated_at string 2024-11-01 17:34:11 Datetime dari terupdatenya transaksi
data.meta object - Meta data terkait pagination
data.meta.current_page integer 1 Nomor halaman dari response API
data.meta.per_page integer 10 Banyak data per halaman dari response API
data.meta.last_page integer 1 Halaman terakhir dari response API
data.meta.total_data integer 1 Jumlah data dari seluruh halaman yang ada

Status Transaksi

data.data.*.status Deskripsi
0 Pending
1 Sukses
2 Gagal
3 Batal

Tipe Barang

Nilai Deskripsi
0 Surat
1 Paket

Test Case Sandbox

{info} Silakan masukan input form sesuai dengan yang diperlukan.

Live Testing Sandbox