EasyParcel Public API

The EasyParcel Public API allows your application to access current data within EasyParcel. However, EasyParcel API is using RESTful with PHP concept to develop API for web based applications.

Getting an API key

May go to our API request page to get the API key.

Base URL Environment

All API URLs start with the following base part:

Environment	URL
Development	http://demo.connect.easyparcel.my/
Production	https://connect.easyparcel.my/

POSTSubscribe Webhook

http://demo.connect.easyparcel.my/?ac=Webhook

This is the endpoint for subscribe a webhook for a topic.

Webhook topic

Topic	Description
shipment/create	trigger when the shipment is created
tracking/create	trigger when new tracking record is created
ondemand/tracking	trigger when new ondemand tracking record is created

Remark

status code 200 mean successful subscribe webhook

Latest url will be used if subscribe same topic multiple times

There will be a maximum of 3 retries for an API call

If no response is received, the API call will timeout in 3 seconds

Example WebHook Response

shipment/create

json

{
    "topic": "shipment/create",
    "payload": {
        "awb": "ABC001",
        "parcel_number": "EP-PXJJW",
        "reference": "testest",
        "parcel_content": "test",
        "currency_code": "MYR",
        "status_code": 7,
        "country": "MY"
    },
    "event_id": "42a71f01086ee4e97c817947a0a86e86"
}

tracking/create

json

{
    "topic": "tracking/create",
    "payload": {
        "awb": "ABC001",
        "sender_name": "Mr. ABC",
        "receiver_name": "XYZ",
        "event_date": "2020-07-09T16:04:39.000Z",
        "description": "Parcel has been collected",
        "status_code": 4,
        "location": "Puchong",
        "country": "MY"
    },
    "event_id": "62402ab822c69674e8af407790e53a04"
}

Status Code

Status Code	Description
0	Cancel
2	To Be Collected
3	Collected/Parcel been collected at ABC
4	Delivery In Transit
5	Delivered/Parcel collected by recipient
6	Returned
7	Schedule In Arrangement
8	Delivery On Hold
10	Cancel by admin
11	Pending drop off at ABC
12	Parcel dropoff at ABC
13	Parcel arrived ABC
14	On Hold

ondemand/tracking

json

{
  "topic": "ondemand/tracking",
  "payload": {
    "order_number": "177191846674",
    "driver": {
      "id": "81994",
      "name": "TestDriver 09090",
      "phone": "+6090909090",
      "rating": "",
      "photo": "",
      "coordinates": {
        "latitude": 0,
        "longitudelatitude": 0
      },
      "vehicle": {
        "licensePlate": "VP5734736",
        "model": "",
        "physicalVehicleType": "Car"
      }
    },
    "status": "IN_TRANSIT",
    "timeline": {
      "allocate": "2024-08-28 15:18",
      "create": "2024-08-28 15:18",
      "pickup": "2024-08-28 15:18"
    },
    "tracking_url": "",
    "update_at": "2024-08-28 15:18"
  },
  "event_id": "62402ab822c69674e8af407790e53a04"
}

Status

Status	Description
SEARCHING_DRIVER	searching driver from other platform
ALLOCATING_DRIVER	system allocating driver
NO_DRIVER	no driver accept the order
DRIVER_PICKUP	driver pickup parcel
IN_TRANSIT	delivery in transit
FULFILLED	order delivery fulfilled
USER_CANCEL	order cancel by user
ADMIN_CANCEL	order cancel by admin
DRIVER_CANCEL	order cancel by driver

HEADERS

Content-Type

application/json

PARAMS

Webhook

Bodyraw (json)

json

{
	"api": "<your_api_key>",
	"webhook": {
		"url": "https://www.example.com",
		"topic": "tracking/create"
	}
}