API Shipping

Dokumentasi lengkap penggunaan API untuk cek ongkir dan lokasi.

1. Pencarian Lokasi (Area ID)

Digunakan untuk mendapatkan area_id yang diperlukan untuk proses hitung ongkir.

GET /api/search-lokasi

Query Parameters

Parameter Tipe Wajib Deskripsi
input String Ya Nama daerah, kota, atau kode pos (min. 3 karakter).
type String Tidak Default: single. Gunakan double untuk pencarian lebih luas.

Contoh Request

GET /api/search-lokasi?input=umbulharjo

Contoh Respon Success

{
  "success": true,
  "areas": [
    {
      "id": "IDNP5IDNC488IDND6359IDZ55161",
      "name": "Umbulharjo, Yogyakarta, DI Yogyakarta. 55161",
      "postal_code": 55161,
      ...
    }
  ]
}

2. Cek Ongkos Kirim

Menghitung biaya pengiriman berdasarkan kurir yang tersedia.

POST /api/cek-ongkir

Request Body (JSON)

{
  "origin_area_id": "IDNP5IDNC488IDND6359IDZ55161",
  "destination_area_id": "IDNP1IDNC17IDND1242IDZ80352",
  "couriers": "jne,sicepat,anteraja,jnt",
  "items": [
    {
      "weight": 1000,
      "length": 1,
      "width": 1,
      "height": 1
    }
  ]
}

Paramater Penjelasan

Field Deskripsi
origin_area_id ID area asal (diambil dari API Search Lokasi).
destination_area_id ID area tujuan.
couriers Daftar kurir dipisah koma.
items Array objek berisi detail berat (gram) dan dimensi (cm).
Kurir yang Didukung:
jne, sicepat, anteraja, wahana, rpx, idexpress, jdl, lion, tiki, jnt, ninja, sap, pos