We'll use the RestAPI protocol with a JSON object body to send an event.
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.
| Key | Value |
|---|---|
Content-Type | application/json |
Accept | application/json |
User-Agent | KiriminAja-Push-Services |
Authorization | Bearer {api_key} |
| 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 |
processed_packagesWhen sending the processed_package callback (AWB creation), we transmit two types of callback data: complete and incomplete (containing only order ID and AWB), The callback data format is configurable based on client requirements.
{
"method": "processed_packages",
"data": [
{
"order_id": "X",
"awb": "Y",
"sorting_code": "JOG-JOG1000-JKT2010"
}
]
}
{
"method": "processed_packages",
"data": [
{
"order_id": "(order_id)",
"awb": "(awb)",
"date": "2025-01-09T06:02:03.000000Z",
"shipped_at": null,
"finished_at": null,
"returned_at": null,
"rejected_at": null,
"reason": null
}
],
"payment": {
"payment_id": "(pid)",
"amount": 11200,
"status_code": 0,
"qr_content": null,
"pay_time": null
},
"packages": [
{
"awb": "(awb)",
"order_id": "(order_id)",
"service": "(courier)",
"service_type": "(service_type)",
"status": 105,
"live_tracking_url": null,
"poly_line": null,
"origin": {
"name": "(name_origin)",
"address": "(address origin)",
"phone": "(phone number of sender)",
"latitude": 0,
"longitude": 0
},
"destination": {
"name": "(name destination)",
"address": "(addreess destination)",
"phone": "(phone number recipient)",
"latitude": null,
"longitude": null
},
"driver": {
"name": null,
"phone": null,
"image": null
}
}
]
}
shipped_packagesIndicate that the package has been picked up, transported, and forwarded by the courier’s operations team.
{
"method": "shipped_packages",
"data": [
{
"order_id": "(order_id)",
"awb": "(awb)",
"date": "2025-01-09T06:02:03.000000Z",
"shipped_at": (shipped date),
"finished_at": null,
"returned_at": null,
"rejected_at": null,
"reason": null
}
],
"payment": {
"payment_id": "(pid)",
"amount": 11200,
"status_code": 0,
"qr_content": null,
"pay_time": null
},
"packages": [
{
"awb": "(awb)",
"order_id": "(order_id)",
"service": "(courier)",
"service_type": "(service_type)",
"status": 105,
"live_tracking_url": null,
"poly_line": null,
"origin": {
"name": "(name_origin)",
"address": "(address origin)",
"phone": "(phone number of sender)",
"latitude": 0,
"longitude": 0
},
"destination": {
"name": "(name destination)",
"address": "(addreess destination)",
"phone": "(phone number recipient)",
"latitude": null,
"longitude": null
},
"driver": {
"name": null,
"phone": null,
"image": null
}
}
]
}
canceled_packagesYour shipment is canceled by system or flagged due 3pl reason
{
"method": "canceled_packages",
"data": [
{
"order_id": "(order_id)",
"awb": "(awb)",
"date": "2025-01-09T06:02:03.000000Z",
"shipped_at": null,
"finished_at": null,
"returned_at": null,
"rejected_at": null,
"reason": null
}
],
"payment": {
"payment_id": "(pid)",
"amount": 11200,
"status_code": 0,
"qr_content": null,
"pay_time": null
},
"packages": [
{
"awb": "(awb)",
"order_id": "(order_id)",
"service": "(courier)",
"service_type": "(service_type)",
"status": 105,
"live_tracking_url": null,
"poly_line": null,
"origin": {
"name": "(name_origin)",
"address": "(address origin)",
"phone": "(phone number of sender)",
"latitude": 0,
"longitude": 0
},
"destination": {
"name": "(name destination)",
"address": "(addreess destination)",
"phone": "(phone number recipient)",
"latitude": null,
"longitude": null
},
"driver": {
"name": null,
"phone": null,
"image": null
}
}
]
}
finished_packagesYour shipment is delivered or received by recipient
{
"method": "finished_packages",
"data": [
{
"order_id": "(order_id)",
"awb": "(awb)",
"date": "2025-01-09T06:02:03.000000Z",
"shipped_at": null,
"finished_at": (date of finish package),
"returned_at": null,
"rejected_at": null,
"reason": null
}
],
"payment": {
"payment_id": "(pid)",
"amount": 11200,
"status_code": 0,
"qr_content": null,
"pay_time": null
},
"packages": [
{
"awb": "(awb)",
"order_id": "(order_id)",
"service": "(courier)",
"service_type": "(service_type)",
"status": 105,
"live_tracking_url": null,
"poly_line": null,
"origin": {
"name": "(name_origin)",
"address": "(address origin)",
"phone": "(phone number of sender)",
"latitude": 0,
"longitude": 0
},
"destination": {
"name": "(name destination)",
"address": "(addreess destination)",
"phone": "(phone number recipient)",
"latitude": null,
"longitude": null
},
"driver": {
"name": null,
"phone": null,
"image": null
}
}
]
}
returned_packages (RTS)Inform if your packages is return flag, when returned_at is filled mean your shipment is successfully returned to origin
{
"method": "returned_packages",
"data": [
{
"order_id": "(order_id)",
"awb": "(awb)",
"date": "2025-01-09T06:02:03.000000Z",
"shipped_at": null,
"finished_at": null,
"returned_at": null,
"rejected_at": null,
"reason": null
}
],
"payment": {
"payment_id": "(pid)",
"amount": 11200,
"status_code": 0,
"qr_content": null,
"pay_time": null
},
"packages": [
{
"awb": "(awb)",
"order_id": "(order_id)",
"service": "(courier)",
"service_type": "(service_type)",
"status": 105,
"live_tracking_url": null,
"poly_line": null,
"origin": {
"name": "(name_origin)",
"address": "(address origin)",
"phone": "(phone number of sender)",
"latitude": 0,
"longitude": 0
},
"destination": {
"name": "(name destination)",
"address": "(addreess destination)",
"phone": "(phone number recipient)",
"latitude": null,
"longitude": null
},
"driver": {
"name": null,
"phone": null,
"image": null
}
}
]
}
return_finished_packages (Deprecated)returned_packages method{
"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"
}
]
}