{"info":{"_postman_id":"f07dec3f-aacf-408c-8eea-4d9484f2e505","name":"EasyParcel Public API","description":"

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.

\n

Getting an API key

\n

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

\n

Base URL Environment

\n

All API URLs start with the following base part:

\n
Environment
URL
Development
http://demo.connect.easyparcel.my/
Production
https://connect.easyparcel.my/
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10519343","collectionId":"f07dec3f-aacf-408c-8eea-4d9484f2e505","publishedId":"TVRpz4zC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-10-15T02:28:50.000Z"},"item":[{"name":"Subscribe Webhook","id":"cacf36a4-0176-460f-aea6-5a49a0a34de1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"api\": \"\",\n\t\"webhook\": {\n\t\t\"url\": \"https://www.example.com\",\n\t\t\"topic\": \"tracking/create\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"http://demo.connect.easyparcel.my/?ac=Webhook","description":"

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

\n

Webhook topic

\n
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
\n\n

Remark

\n
    \n

  1. status code 200 mean successful subscribe webhook

    \n
    2. \n

  2. Latest url will be used if subscribe same topic multiple times

    \n
    3. \n

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

    \n
    4. \n

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

    \n
    5. \n
\n

Example WebHook Response

\n

shipment/create

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

tracking/create

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

Status Code

\n
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
\n\n

ondemand/tracking

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

Status

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusDescription
SEARCHING_DRIVERsearching driver from other platform
ALLOCATING_DRIVERsystem allocating driver
NO_DRIVERno driver accept the order
DRIVER_PICKUPdriver pickup parcel
IN_TRANSITdelivery in transit
FULFILLEDorder delivery fulfilled
USER_CANCELorder cancel by user
ADMIN_CANCELorder cancel by admin
DRIVER_CANCELorder cancel by driver
\n
","urlObject":{"protocol":"http","path":[""],"host":["demo","connect","easyparcel","my"],"query":[{"key":"ac","value":"Webhook"}],"variable":[]}},"response":[],"_postman_id":"cacf36a4-0176-460f-aea6-5a49a0a34de1"}]}