Cek Wilayah

Pendahuluan

API Cek Region berfungsi untuk mendapatkan data daerah dari pengirim ataupun penerima. Cari Region ini berdasarkan Kode pos, Kelurahan, Kecamatan, atau Kota.

Endpoint

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

Headers

{info} Silakan gunakan token pada akun Anda.

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

Request Sample

Nama Tipe Data Required Contoh Deskripsi
keyword string ✔️ Tambora Kata kunci dari nama Kode pos, Kelurahan, Kecamatan, atau Kota yang diinginkan

Responses

{success} Berikut contoh dan penjelasan response get_region 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.*.zip_code string 11220 Kode pos data wilayah hasil pencarian
data.*.sub_district string Kel. Tambora Nama kelurahan dari data wilayah hasil pencarian
data.*.district string Tambora Nama kecamatan dari data wilayah hasil pencarian
data.*.city string Kota Adm. Jakarta Barat Nama kota dari data wilayah hasil pencarian
data.*.province string Dki Jakarta Nama provinsi dari data wilayah hasil pencarian
data.*.country string INDONESIA Nama negara dari data wilayah hasil pencarian

Test Case Sandbox

{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.

keyword keterangan
Tambora Sukses Tambora
Buahbatu Sukses Buahbatu
Pinang Sukses Pinang
test123 Sukses dengan data kosong

Live Testing Sandbox