Pada halaman ini, akan dijelaskan penggunaan API untuk berinterakasi dengan tabel lookup Courier Aliases.
API List
Method ini digunakan untuk mendapatkan data courier aliases yang tersedia.
Request
| METHOD | URL |
|---|---|
| GET | http://apiv2.mitrabunso.com/public/courier/aliases/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": 96,
"data": [
{
"deleted_at": null,
"id": "0897c7d4-7f0e-449f-af1d-5c5f2d8cb8d2",
"courier": "8e427c4c-883b-42c5-8397-abcc4d0123d9",
"alias": "ANTERAJASAME DAY",
"courierName": "Anter Aja (Same Day)",
"created": {
"date": "2022-05-05 01:58:11.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-05-05 12:37:49.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"createdBy": "dc7f9c3b-7e46-4b9a-9a39-f9854867d2f4",
"updatedBy": "5dff9be2-c24d-41dc-8078-1ebf9e3448f6",
"createdByName": "Albert Sebastian",
"updatedByName": "Albert Sebastian"
}
]
}
API Create
Method ini digunakan untuk memasukan data courier aliases.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/courier/aliases/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 | alias | YA | STRING | Nama alias untuk courier |
| POST | courier | YA | STRING | 36 charakter id courier |
Response
{
"message": "Data added successfully",
"data": {
"deleted_at": null,
"id": "73218f5d-9c40-40c8-bf99-03362a82d5e2",
"courier": "12d03335-108e-4093-a578-38b4ef28d762",
"alias": "CR Aliases 1 test",
"courierName": null,
"created": {
"date": "2022-10-10 10:20:44.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 10:20:44.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 aliases.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/courier/aliases/update/{id_user}/{id_courier_aliases} |
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_aliases | YA | STRING | 36 character id courier aliases |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
| POST | alias | YA | STRING | Nama alias untuk courier |
| POST | courier | YA | STRING | 36 charakter id courier |
Response
{
"message": "Data updated successfully",
"data": {
"deleted_at": null,
"id": "73218f5d-9c40-40c8-bf99-03362a82d5e2",
"courier": "12d03335-108e-4093-a578-38b4ef28d762",
"alias": "CR Aliases 1 test edited",
"courierName": null,
"created": {
"date": "2022-10-10 10:20:44.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 10:21:47.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 aliases.
Request
| METHOD | URL |
|---|---|
| POST | http://apiv2.mitrabunso.com/public/courier/aliases/details/{id_user}/{id_courier_aliases} |
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_aliases | YA | STRING | 36 character id courier aliases |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "Data retrieved successfully",
"data": {
"deleted_at": null,
"id": "73218f5d-9c40-40c8-bf99-03362a82d5e2",
"courier": "12d03335-108e-4093-a578-38b4ef28d762",
"alias": "CR Aliases 1 test",
"courierName": "JNT Economy",
"created": {
"date": "2022-10-10 10:20:44.000000",
"timezone_type": 3,
"timezone": "Asia/Bangkok"
},
"updated": {
"date": "2022-10-10 10:20:44.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 aliases.
Request
| METHOD | URL |
|---|---|
| DELETE | http://apiv2.mitrabunso.com/public/courier/aliases/delete/{id_user}/{id_courier_aliases} |
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_aliases | YA | STRING | 36 character id courier aliases |
| HEAD | Authorization | YA | Bearer Token | Bearer Token Login |
Response
{
"message": "data deleted successfully"
}