Pada halaman ini, akan dijelaskan penggunaaan API untuk berinterakasi dengan tabel lookup Courier.
API List
Method ini digunakan untuk mendapatkan data courier yang tersedia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/courier/couriers/list/{id_user}/{offsite}/{limit} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | offsite | YA | int | offsite data |
| GET | limit | YA | int | limit data |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| GET | q | TIDAK | STRING | Parameter untuk pencarian |
| GET | orderBy | TIDAK | STRING | Parameter untuk pengurutan berdasarkan data |
Response
{
"message": "Data retrieved successfully",
"show": "1",
"total": 38,
"data": [
{
"deleted_at": null,
"id": "12d03335-108e-4093-a578-38b4ef28d762",
"status": "1",
"name": "JNT Economy",
"created": {
"date": "2022-05-04 17:47:06.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-05-04 17:47:06.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "5dff9be2-c24d-41dc-8078-1ebf9e3448f6",
"updatedBy": "",
"createdByName": "Albert Sebastian",
"updatedByName": null
}
]
}
API Create
Method ini digunakan untuk memasukan data courier.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/courier/couriers/create/{id_user} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 charakter id user |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | name | YA | STRING | Nama untuk courier |
Response
{
"message": "Data added successfully",
"data": {
"deleted_at": null,
"id": "3f3d0836-b330-4065-97d3-8439a38e8782",
"status": "1",
"name": "Courier Test 1",
"created": {
"date": "2022-10-10 10:01:08.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 10:01:08.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
"updatedBy": "",
"createdByName": null,
"updatedByName": null
}
}
API Update
Method ini digunakan untuk mengubah data courier.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/courier/couriers/update/{id_user}/{id_courier} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | id_courier | YA | STRING | 36 character id courier |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | name | YA | STRING | Nama untuk courier |
Response
{
"message": "Data updated successfully",
"data": {
"deleted_at": null,
"id": "3f3d0836-b330-4065-97d3-8439a38e8782",
"status": "1",
"name": "Courier Test 1 edited",
"created": {
"date": "2022-10-10 10:01:08.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 10:02:00.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
"updatedBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
"createdByName": null,
"updatedByName": null
}
}
API Details
Method ini digunakan untuk mendapatkan data details courier.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/courier/couriers/details/{id_user}/{id_courier} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | id_courier | YA | STRING | 36 character id courier |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "Data retrieved successfully",
"data": {
"deleted_at": null,
"id": "3f3d0836-b330-4065-97d3-8439a38e8782",
"status": "1",
"name": "Courier Test 1",
"created": {
"date": "2022-10-10 10:01:08.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 10:01:08.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "2888cc3b-0478-4e85-be41-7baf74fedf36",
"updatedBy": "",
"createdByName": null,
"updatedByName": null
}
}
API Delete
Method ini digunakan untuk menghapus data courier.
Request
| METHOD | URL |
|---|---|
| DELETE | http://apiv2.mitrabunso.com/public/courier/couriers/delete/{id_user}/{id_courier} |
Parameter yang digunakan pada method ini adalah sebagai berikut:
| METHOD | Parameter | Wajib | Tipe | Keterangan |
|---|---|---|---|---|
| GET | id_user | YA | STRING | 36 character id user |
| GET | id_courier | YA | STRING | 36 character id courier |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "data deleted successfully"
}