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	Value
Authorization	Bearer {your_token}
Content-Type	application/json
Accept	application/json
User-Agent	KiriminAja-Push-Services

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_packages

info

This updates indicate your order id is successfully validated and the awb number is generated

{
  "method": "processed_packages",
  "data": [
    {
      "order_id": "X",
      "awb": "Y",
      "sorting_code": "JOG-JOG1000-JKT2010"
    }
  ]
}

shipped_packages

info

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"
    }
  ]
}

canceled_packages

info

Your shipment is canceled by system or flagged due 3pl reason

{
  "method": "canceled_packages",
  "data": [
    {
      "order_id": "X",
      "date": "2022-05-05 00:00:00",
      "canceled_at": "2022-05-05 00:00:00",
      "reason": "3pl rejection"
    }
  ]
}

finished_packages

info

Your shipment is delivered or received by recipient

{
  "method": "finished_packages",
  "data": [
    {
      "order_id": "X",
      "finished_at": "2022-05-05 00:00:00"
    }
  ]
}

returned_packages (RTS)

info

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": "X",
      "returned_at": "2022-05-05 00:00:00"
    }
  ]
}

return_finished_packages (Deprecated)

warning

This method is deprecated due 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"
    }
  ]
} 

Instant Delivery

update_instant_packages

{
  "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