Referensi Endpoint
Ringkasan
GET /v1/couriers mengembalikan daftar kurir yang didukung beserta kode, nama tampilan, dan URL logo. Gunakan endpoint ini untuk membangun daftar filter kurir di UI Anda atau untuk memvalidasi nilai yang akan dikirim ke field couriers pada POST /v1/rates.
Base URL: https://api.agenwebsite.com/v1 · Autentikasi lewat header x-api-key.
Pada v1 hanya lima kurir yang didukung dan semuanya untuk pengiriman reguler non-COD. Field
cod_supported saat ini selalu false (COD ada di roadmap).Contoh Request
Request · cURL
curl https://api.agenwebsite.com/v1/couriers \
-H "x-api-key: awk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"Contoh Response
Response · 200 OK
{
"success": true,
"data": {
"couriers": [
{
"courier_code": "jnt",
"courier_name": "J&T Express",
"courier_logo_url": "https://cdn.agenwebsite.com/couriers/jnt.png",
"cod_supported": false,
"regular_supported": true
},
{
"courier_code": "lion",
"courier_name": "Lion Parcel",
"courier_logo_url": "https://cdn.agenwebsite.com/couriers/lion.png",
"cod_supported": false,
"regular_supported": true
},
{
"courier_code": "sap",
"courier_name": "SAP Express",
"courier_logo_url": "https://cdn.agenwebsite.com/couriers/sap.png",
"cod_supported": false,
"regular_supported": true
},
{
"courier_code": "spx",
"courier_name": "SPX Express",
"courier_logo_url": "https://cdn.agenwebsite.com/couriers/spx.png",
"cod_supported": false,
"regular_supported": true
},
{
"courier_code": "jtc",
"courier_name": "J&T Cargo",
"courier_logo_url": "https://cdn.agenwebsite.com/couriers/jtc.png",
"cod_supported": false,
"regular_supported": true
}
]
}
}Tabel Kurir Didukung
Nilai courier_code di bawah inilah yang dipakai pada array couriers di POST /v1/rates dan yang muncul pada rates[].courier_code di response tarif.
courier_code |
Nama Kurir | Layanan v1 |
|---|---|---|
jnt |
J&T Express | Reguler |
lion |
Lion Parcel | Reguler |
sap |
SAP Express | Reguler |
spx |
SPX Express | Reguler |
jtc |
J&T Cargo | Reguler (kargo) |
Field Response
| Field | Tipe | Keterangan |
|---|---|---|
courier_code |
string | Kode kurir untuk dipakai di request tarif. |
courier_name |
string | Nama tampilan kurir. |
courier_logo_url |
string | URL logo siap pakai di UI. |
cod_supported |
boolean | Dukungan COD. Pada v1 selalu false. |
regular_supported |
boolean | Dukungan pengiriman reguler. Pada v1 selalu true. |
Meminta kurir tak didukung? Jika Anda mengirim kode di luar lima kurir ini pada
POST /v1/rates, API mengembalikan 422 unsupported_courier. Selalu validasi input pengguna terhadap daftar dari endpoint ini.