Here's how you connect to 3PL to get pickup request and also get awb for courier driver reference
[POST] /api/mitra/v4/instant/pickup/request
Payload
| Payload | Values | Type | Required |
|---|---|---|---|
service | Courier code grab_express, borzo, gosend | String | YES |
service_type | Price result.costs..service_type | String | YES |
vehicle | motor (Bike) or mobil (Car) | String | YES |
order_prefix | Your seller order Prefix, we will use for generate order id | String | YES |
packages | Package Object | Array Of Object | YES |
Here is the translation of the table to English:
| Payload | Values | Type | Required |
|---|---|---|---|
origin_name | Sender Name | string | YES |
origin_phone | Sender Phone Number, use a country phone scope | string | YES |
origin_lat | Sender Origin Latitude | float | YES |
origin_long | Sender Origin Longitude | float | YES |
origin_address | Sender Origin Address Detail | string | YES |
origin_address_note | Sender Origin Address Detail Note e.g "Dekat Kantor" | string | YES |
destination_name | Receiver Name | string | YES |
destination_phone | Receiver Phone Number, use a country phone scope | string | YES |
destination_lat | Receiver Origin Latitude | float | YES |
destination_long | Receiver Origin Longitude | float | YES |
destination_address | Receiver Origin Address Detail | string | YES |
destination_address_note | Receiver Origin Address Detail Note e.g "Dekat Kantor" | string | YES |
shipping_price | Your shipping cost value, we use for validation | int | YES |
item | Item detail | object | YES |
Item Object
| Pyload | values | Type | Required |
|---|---|---|---|
| name | The item name | String | YES |
| description | The item description | String | YES |
| price | Your goods value for insurance purpose | Integer | YES |
| weight | Package Weight in Gram | Integer | YES |
{
"service": "gosend",
"service_type": "instant",
"vehicle": "motor",
"order_prefix": "BDI",
"packages": [
{
"destination_name": "Okka Syahputra",
"destination_phone": "081280045616",
"destination_lat": -7.776192418965594,
"destination_long": 110.32505379554323,
"destination_address": "Godean, Sidoarum, Sleman",
"destination_address_note": "Tidak Ada Destination",
"origin_name": "Rizky Syahputra",
"origin_phone": "081280045616",
"origin_lat": -7.854584796417944,
"origin_long": 110.33115444430031,
"origin_address": "Wirobrajan, Kota Yogyakarta, Daerah Istimewa Yogyakarta, Indonesia",
"origin_address_note": "Tidak Ada Origin",
"shipping_price": 34000,
"item": {
"name": "Barang 1",
"description": "Barang 1 Description",
"price": 20000,
"weight": 1000
}
}
]
}
{
"status": true,
"text": "success",
"code": 0,
"method": null,
"result": {
"payment": {
"payment_id": "PID-1736406074",
"amount": 34000,
"status_code": "Pembayaran berhasil",
"qr_content": null,
"pay_time": null
},
"packages": [
{
"awb": "GK-11-3177494",
"order_id": "BDI-1736406073777",
"service": "gosend",
"service_type": "instant",
"status": 105,
"live_track_url": null,
"poly_line": "db}n@{`l`TyAYp@yDhAaIt@yEd@wBTwAx@{FbAaGRgBf@_CjA}H?IoMoBeEi@iBY{PaCcCg@cGcCqFqBi@jIg@a@eNeBeKwA}Dc@u@Ck`@QuMIiCKcATu@?_AUuMUmC[SCQGUgAe@a@UCiCGsAEKAANsEhe@CfIXzKGh@Qr@Ul@mPzXa@nAYjAKbAIlEKnTQx@QZW\\_@Zk@T]Fk@@c{@mB}a@mAkAO_Bm@aAMqXJ[AOEMsAAo@H_@vCqKF_@Ae@Oe@c@o@m@g@_C_B_@[wAw@w@@iUu@uLe@}]eAkBCyJ]}KS?JqFQsBO_CI}FOeGUkDWo@GqAE]Lc@XCLGrA?fE@p@AN[|Am@|AO\\c@r@_@v@_@~BYrBo@jD`B\\XDLL@PKt@@J",
"origin": {
"name": "Rizky Syahputra",
"address": "Wirobrajan, Kota Yogyakarta, Daerah Istimewa Yogyakarta, Indonesia",
"phone": "081280045616",
"lat_long": "-7.8545847964179,110.3311544443"
},
"destination": {
"name": "Okka Syahputra",
"address": "Godean, Sidoarum, Sleman",
"phone": "081280045616",
"lat_long": "-7.7761924189656,110.32505379554"
},
"driver": {
"name": null,
"phone": null,
"image": null
}
}
]
}
}
{
"status": false,
"text": "cannot process the request, distance more than 40km",
"code": 2,
"method": null,
"result": null
}