This webhook documentation explains the event tracking used to monitor the shipment status of 3PLs connected to the OEXPRESS dashboard, ensuring you receive real-time notifications whenever there is a status update.

ℹ️ This webhook is intended for use in production environments only.

URL

Endpoint URL: HTTP

HTTP Method

Method: POST

Request Body

The webhook will send data in JSON format with the following structure:

{
  "tracking_number": "OEX1137077",
  "shipping_cost": 2000,
  "weight": 1000,
  "actual_shipping_cost": 0,
  "actual_weight": 0,
  "logistic_partner": "oexpress",
  "logistic_partner_awb": "OEXOEX1137077",
  "status": "delivered",
  "histories": [
    {
      "date": "2024-08-21 10:21:00",
      "status": "Proof of Delivery - DELIVERED",
      "notes": "Package is DELIVERED [DITERIMA] - Receiver : [ROBERT - SECURITY] - Description : [OKE] - Courier : [TEUNGKU RAJA FARISI]",
      "pod": "https://core-api.oexpress.id/file_image/new_photo/092023/pod_img_ca14904f-cf69-4e54-ac7a-dd6cf951b381.jpeg",
      "proof": "https://core-api.oexpress.id/file_image/new_photo/092023/pod_img_ca14904f-cf69-4e54-ac7a-dd6cf951b381.jpeg",
      "flag": "success",
      "oex_status": "delivered"
    }
  ],
  "pod": {
    "date": "2024-08-21 10:21:00",
    "latitude": "-6.2274506",
    "longitude": "106.8003243",
    "pod_photo": "https://core-api.oexpress.id/file_image/new_photo/092023/pod_img_ca14904f-cf69-4e54-ac7a-dd6cf951b381.jpeg",
    "pod_signature": "https://core-api.oexpress.id/file_image/new_signature/092023/pod_sgn_b6a423f4-263f-4ce8-9a35-6872d1bb80b6.jpeg",
    "pod_receiver_name": "ROBERT",
    "pod_relation_name": "SECURITY"
  },
  "type": "tracking"
}

Field Description

• tracking_number : The tracking number of the shipment.
• shipping_cost : The shipping cost entered when creating the shipment.
• weight : The weight of the shipment.
• actual_shipping_cost : The adjusted shipping cost based on the actual weight.
• actual_weight : The adjusted weight of the shipment based on the actual measurements.
• logistic_partner : The name of the logistics provider used for shipping.
• logistic_partner_awb : The AWB (Air Waybill) number from the 3PL used.
• status : The latest status received from the shipment's history.
• histories : A list of the shipment's status history.
  • date : The date when the shipment status was updated.
  • status : The shipment status provided by the 3PL used.
  • notes : Notes related to the shipment.
  • pod : Proof of delivery for the shipment.
  • proof : Proof of delivery for the shipment.
  • flag : Indicator of the shipment status.
  • oex_status : The mapped shipment status for the OEX dashboard.
• pod : Proof of delivery for the shipment.
  • date : The date the shipment was received.
  • latitude : The latitude coordinate indicating the north or south position of the delivery location relative to the equator.
  • longtitude : The longitude coordinate indicating the east or west position of the delivery location relative to the prime meridian (Greenwich).
  • pod_photo : Photo proof of package delivery.
  • pod_signature : Photo of the signed delivery receipt.
  • pod_receiver_name : Name of the person who received the shipment.
  • pod_relation_name : The relationship between the person who received the package and the intended recipient.
• type : The type of webhook being sent.

Response