Get Vendor by Name
Deskripsi
API ini digunakan untuk mengambil daftar vendor berdasarkan keyword vendor yang diketik oleh pengguna, dengan dukungan untuk filter paginasi (page, limit) dan status aktif.
Method | URL |
---|---|
GET |
|
Request
Parameter | Tipe | Wajib | Keterangan |
---|---|---|---|
keyword | String | Tidak | Kata yang diketik: PT Maju Mundur |
page | Integer | Ya | Nomor halaman. Default: 1 |
limit | Integer | Ya | Jumlah data per halaman (opsi: 5 , 10 , 20 , 50 , 100 ). Default: 10 |
status | String | Ya | Filter status produk. Contoh: active |
Contoh Request
GET {{base_url}}/api/v2/bumn/vendor/list?Limit=20&Page=1&keyword=PT+Majumundur
Response
Success
Status | Payload |
---|---|
200 |
|
Params | Tipe Data | Deskripsi |
---|---|---|
status | STRING | Status dari permintaan ke server. Nilai: "success " atau "error ". |
data | OBJECT | Objek utama yang berisi metadata dan detail informasi seller. |
data .meta | OBJECT | Metadata terkait paginasi hasil permintaan. |
data.meta .first | STRING | URL halaman pertama dari hasil paginasi. |
data.meta .limit | INTEGER | Jumlah data per halaman. |
data.meta .last | STRING | URL halaman terakhir dari hasil paginasi. |
data.meta .next | STRING | URL ke halaman selanjutnya. |
data.meta .page | INTEGER | Nomor halaman saat ini. |
data.meta .prev | STRING | URL ke halaman sebelumnya. |
data.meta .total_data | INTEGER | Jumlah total data yang tersedia. |
data.meta .total_page | INTEGER | Jumlah total halaman yang tersedia. |
data .nama_seller | STRING | Nama dari penjual atau perusahaan. |
data .seller_id | STRING | ID unik dari seller. |
data .status_perusahaan | STRING | Status perusahaan: "pkp" atau "non pkp". |
data .bentuk_perusahaan | STRING | Bentuk hukum perusahaan, seperti "CV" atau "PT". |
data .tipe_perusahaan | STRING | Tipe perusahaan, seperti "umkm". |
data .ketegori_tipe_perusahaan | STRING | Kategori tipe perusahaan, seperti "mikro". |
data .jenis_kegiatan_utama | STRING | Jenis kegiatan usaha utama perusahaan. |
data .provinsi | STRING | Lokasi provinsi perusahaan |
data .kota | STRING | Lokasi kota perusahaan |
data .kecamatan | STRING | Lokasi kecamatan perusahaan |
data .profile_picture | STRING | URL atau referensi ke gambar profil seller. |
Error
Case | Status | Message |
---|---|---|
Failed to get response because bad internet | 400 | "Bad Request" |
Failed to set shipping cost | 400 | "Failed to set shipping cost" |
Failed to get data from collect bill | 400 | "Failed to collect bill" |
Failed to get data from calculate bill | 400 | "Failed to calculate bill" |
Failed to hit create order | 400 | "Failed to create orders" |
ERP user does not match the token obtained from the API Login | 400 | "Invalid User ERP" |
payment_type is not available | 400 | "Payment type is not available" |
payment_term is not available | 400 | "Payment terms is not available" |
payment_method is not available | 400 | "Payment method is not available" |
Invalid shipping_address_id | 404 | "Address Not Found" |
Transaction not found | 404 | "Transaction Not Found" |
Invalid product_id | 404 | "Product Not Found" |
Invalid courier_code | 404 | "Courrier Not Found " |
Courier not found | 404 | "Product Detail Not Found" |
Internal Server Error | 500 | "Internal Server Error" |