Event (Overview)
We'll use the RestAPI protocol with a JSON object body.
info
If our endpoint is down, you can use the pull tracking API to continue tracking your shipments. This alternative method allows you to request and retrieve tracking information directly, ensuring you stay updated on your shipment status even if our primary endpoint is temporarily unavailable.
Header
Key | Type | Value |
---|---|---|
Authorization | Bearer | Bearer {your_token} |
Parameter
Parameter | Type | Description |
---|---|---|
method | String | We'll write the method name following the data being sent (plural or singular) |
data | Mixed | We will use the data according to the method. View each event to see its characteristics |
Event (Express)
Processed
Akan dikirimkan pada saat AWB milik order id terbuat atau digenerate oleh sistem
{
"method": "processed_packages",
"data": [
{
"order_id": "X",
"awb": "Y"
}
]
}
Shipped
Indicate that the package has been picked up, transported, and forwarded by the courier’s operations team.
{
"method": "shipped_packages",
"data": [
{
"order_id": "X",
"shipped_at": "2022-05-05 00:00:00"
}
]
}
Delivered / Finished
Akan dikirimkan pada saat paket telah sampai ke tujuan
{
"method": "finished_packages",
"data": [
{
"order_id": "X",
"finished_at": "2022-05-05 00:00:00"
}
]
}
RTS Finish
{
"method": "returned_packages",
"data": [
{
"order_id": "X",
"returned_at": "2022-05-05 00:00:00"
}
]
}
Return Finished
Akan dikirimkan pada saat paket telah sampai ke pengirim.
{
"method": "return_finished_packages",
"data": [
{
"order_id": "OID-40592020",
"date": "2021-03-31 00:00:00"
},
{
"order_id": "OID-40592021",
"date": "2021-03-31 00:00:00"
}
]
}
Instant Delivery
Body Payload
{
"method": "update_instant_packages",
"data": {
"order_id": "NBL2-1704870212382",
"status": "cancel",
"awb": "GK-11-3114100",
"driver": {
"name": "string",
"phone": "string",
"image": "string"
},
"shipping_price": 34000,
"live_track_url": "http://gjk.io/abcd",
"detail": {
"weight": 2000,
"width": null,
"height": null,
"length": null
},
"insurance": null,
"insurance_amount": null,
"service": "gosend",
"service_name": "instant",
"poly_line": "string of polyline",
"event_date": "2024-01-10T08:21:28.301662Z",
"cancel_date": "2024-01-10T08:18:05.000000Z",
"cancel_reason": null,
"rejected_date": null,
"rejection_note": null
}
}
Status Code
Status | Description |
---|---|
picked_up | The package is carried out by driver and will be shipped to your customers |
sent | Still on delivery process to your customer |
no_driver | Your instant delivery driver allocation doesn't success cause some reason |
delivered | Your package successfully delivered |
cancel | The package is cancelled via kiriminaja platform (your request) |
return | The customer is rejecting your package |
returned | Your package successfully return to shipper address |