{"info":{"_postman_id":"14e765df-fd47-e445-22d4-dc27dda79905","name":"Pgeon Public API","description":"

Pgeon Public API documentation
https://www.pgeon.delivery \n\f

\n

Forewords

\n\n

Data transaction and access used on this document are using Representational State Transfer (REST) Architecture.
Token mechanism also used on data transfer between every request to the server.

\n

More information about REST can be found at https://en.wikipedia.org/wiki/Representational_state_transfer and https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol .

\n

API Key

\n

Production

\n\n

May signup here and go to our API request page to get the API key.

\n

Sandbox

\n\n

May signup here and go to our API request page to get the API key.

\n

API Example:
https://public-api-sandbox.pgeon.delivery
with Post Method and HTTP Headers: Content-Type: application/json Both request (data POST) and response are on JSON (more information at https://en.wikipedia.org/wiki/JSON) format.

\n

For Any Technical Support needs feel free to drop us an email at tech-support@pgeon.delivery or contacting your person in charge on PGEON Express Sdn Bhd.

API Specification Doc

VersionDateAuthorDescription
1.026 Jan 2018Pgeon Tech TeamPublic API
1.16 March 2018Pgeon Tech TeamUpdated Tracking Code

URL

EnvironmentRemark
Developmenthttps://public-api-sandbox.pgeon.delivery
Production / UAThttps://public-api.pgeon.delivery
\n
\n

Sandbox Credit Card

\nCan find the sandbox credit card here.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2566272","collectionId":"14e765df-fd47-e445-22d4-dc27dda79905","publishedId":"7TMCY1Y","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-01-27T04:59:29.000Z"},"item":[{"name":"List Point","id":"0d4b4956-44a8-735e-e74b-34447e12fd99","request":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://public-api-sandbox.pgeon.delivery/public/point","description":"

Get pgeon point
\n
\nHeader
\napikey : (your api key), required
\nContent-Type : application/json, required
\n
\nGet Parameter
\ncountry : required, ISO 3166 format
\npostcode : optional
\nstate : optional, ISO 3166-2 format
\nradius : optional, in kilometer
\nlon : optional, required if radius or lat is present
\nlat : optional, required if radius or lon is present
\ncod : optional, boolean
\n
\nRemark
\nIf postcode and state both present, the pgeon point list will base on postcode.
\nIf radius, lat and lon is present, will return the pgeon point within the radius base on the lat and lon.
\nIf cod (Cash on Delivery) is true, will only return the pgeon point that support COD base on apikey.
\nRate limit 60 request per minute

\n","urlObject":{"protocol":"https","path":["public","point"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d4b4956-44a8-735e-e74b-34447e12fd99"},{"name":"Make Order - v1","id":"95eafd1e-1f6b-5423-9607-1d9c71f55f46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"service\" : \"dd\",\n \"from_point\":\"PGEON_P_E\",\n \"to_point\":\"PGEON_P_E\",\n \"sender_name\":\"zijian\",\n \"sender_phone_number\":\"60123456789\",\n \"sender_phone_country\":\"MY\",\n \"sender_email\":\"zijian71@hotmail.com\",\n \"sender_addr1\":\"479, Mukim 13\",\n \"sender_addr2\":\"Persiaran Sungai Dua\",\n \"sender_addr3\":\"\",\n \"sender_addr4\":\"\",\n \"sender_postcode\":\"11700\",\n \"sender_city\":\"Gelugor\",\n \"sender_state\":\"07\",\n \"sender_country\":\"my\",\n \"receiver_name\":\"zijian\",\n \"receiver_phone_number\":\"60123456789\",\n \"receiver_phone_country\":\"my\",\n \"receiver_email\":\"zijian71@hotmail.com\",\n \"receiver_addr1\":\"479, Mukim 13\",\n \"receiver_addr2\":\"Persiaran Sungai Dua\",\n \"receiver_addr3\":\"\",\n \"receiver_addr4\":\"\",\n \"receiver_postcode\":\"88000\",\n \"receiver_city\":\"Gelugor\",\n \"receiver_country\":\"my\",\n \"parcel_weight\":\"0.1\",\n \"parcel_content\":\"gold\",\n \"parcel_value\":\"10.00\",\n \"collection_date\": \"\",\n \"content_category\": \"6307904000\"\n}"},"url":"https://public-api-sandbox.pgeon.delivery/public/order","description":"

Create a order for shipment
\n
\nHeader
\napikey : (your api key), required
\nContent-Type : application/json, required
\n
\n Body
\nFill in the body content according below example base on the service you want to perform.
\n
\n Point to point
\n service : PP, required
\nsender_name : required, more than 3 character
\nsender_phone_number : required
\nsender_phone_country : required
\nsender_email : required
\nreceiver_name : required
\nreceiver_phone_number : required
\nreceiver_phone_country : required
\nreceiver_email : required
\n from_point : required
\n to_point : required
\nparcel_weight : required
\nparcel_content : required
\nparcel_value : required
\ncollection_date : optional
\nawb : optional, if you want to specific which tracking number/your own consignment note
\ncod : optional, boolean, required when it is a COD order
\n
\n
\n Point to door
\n service : PD, required
\nsender_name : required, more than 3 character
\nsender_phone_number : required
\nsender_phone_country : required
\nsender_email : required
\nreceiver_name : required
\nreceiver_phone_number : required
\nreceiver_phone_country : required
\nreceiver_email : required
\n receiver_addr1 : required
\n receiver_addr2 : optional
\n receiver_addr3 : optional
\n receiver_addr4 : optional
\n receiver_postcode : required
\n receiver_city : required
\n receiver_state : required, ISO 3166-2 format
\n receiver_country : required, ISO 3166 format
\n from_point : required
\nparcel_weight : required
\nparcel_content : required
\nparcel_value : required
\ncollection_date : optional
\nawb : optional, if you want to specific which tracking number/your own consignment note
\ncod : optional, boolean, required when it is a COD order
\n
\n
\n Door to point
\n service : DP, required
\nsender_name : required, more than 3 character
\nsender_phone_number : required
\nsender_phone_country : required
\nsender_email : required
\nreceiver_name : required
\nreceiver_phone_number : required
\nreceiver_phone_country : required
\nreceiver_email : required
\n sender_addr1 : required
\n sender_addr2 : optional
\n sender_addr3 : optional
\n sender_addr4 : optional
\n sender_postcode : required
\n sender_city : required
\n sender_state : required, ISO 3166-2 format
\n sender_country : required, ISO 3166 format
\n to_point : required
\nparcel_weight : required
\nparcel_content : required
\nparcel_value : required
\ncollection_date : optional
\nawb : optional, if you want to specific which tracking number/your own consignment note
\ncod : optional, boolean, required when it is a COD order
\n
\n
\n Door to door
\n service : DD, required
\nsender_name : required, more than 3 character
\nsender_phone_number : required
\nsender_phone_country : required
\nsender_email : required
\nreceiver_name : required
\nreceiver_phone_number : required
\nreceiver_phone_country : required
\nreceiver_email : required
\n sender_addr1 : required
\n sender_addr2 : optional
\n sender_addr3 : optional
\n sender_addr4 : optional
\n sender_postcode : required
\n sender_city : required
\n sender_state : required, ISO 3166-2 format
\n sender_country : required, ISO 3166 format
\n receiver_addr1 : required
\n receiver_addr2 : optional
\n receiver_addr3 : optional
\n receiver_addr4 : optional
\n receiver_postcode : required
\n receiver_city : required
\n receiver_state : required, ISO 3166-2 format
\n receiver_country : required, ISO 3166 format
\nparcel_weight : required
\nparcel_content : required
\nparcel_value : required
\ncollection_date : optional
\nawb : optional, if you want to specific which tracking number/your own consignment note
\ncod : optional, boolean, required when it is a COD order
\n
\n
\n Pgeon Dropoff \nOnly book for a parcel to drop-off by customer only, no delivery involvement
\n service : dropoff, required
\nsender_name : optional, more than 3 character
\nsender_phone_number : optional
\nsender_phone_country : optional
\nsender_email : optional
\nreceiver_name : optional, more than 3 character
\nreceiver_phone_number : optional
\nreceiver_phone_country : optional
\nreceiver_email : optional
\n branch_code : required
\n parcel_weight : required
\n parcel_content : required
\n parcel_value : required
\n courier_code : required (You can get it from Get Courier List Endpoint)
\nawb : optional, if you want to specific which tracking number/your own consignment note
\n
\n
\n Pgeon Pickup \nOnly book for a parcel to pickup by customer only as known as Pgeon Collect, no delivery involvement, if you are a courier service, may choose this as your option
\n service : pickup, required
\n sender_name : optional, more than 3 character
\n sender_phone_number : optional
\n sender_phone_country : optional
\n sender_email : optional
\n receiver_name : optional, more than 3 character
\n receiver_phone_number : required
\n receiver_phone_country : required
\n receiver_email : optional
\n branch_code : required
\n parcel_weight : required
\n parcel_content : required
\n parcel_value : required
\n courier_code : required (You can get it from Get Courier List Endpoint)
\nawb : optional, if you want to specific which tracking number/your own consignment note
\n
\nResponse Example

\n
\n{\n    \"status_code\": 200,\n    \"error\": {\n        \"message\": \"\"\n    },\n    \"data\": {\n        \"order_number\": \"POOAFGM0I4\",\n        \"senderAddress\": {\n            \"name\": \"zijian\",\n            \"contact_number\": \"60127941677\",\n            \"contact_number_country_code\": \"MY\",\n            \"email\": \"easy2@hotmail.com\",\n            \"addr1\": \"321 Mukim 123\",\n            \"addr2\": \"Persiaran Sungai Dua\",\n            \"addr3\": \"\",\n            \"addr4\": \"\",\n            \"postcode\": \"11800\",\n            \"city\": \"Gelugor\",\n            \"state\": \"Pulau Pinang\",\n            \"country\": \"Malaysia\"\n        },\n        \"receiverAddress\": {\n            \"name\": \"parcel\",\n            \"contact_number\": \"60127941677\",\n            \"contact_number_country_code\": \"MY\",\n            \"email\": \"parcel@hotmail.com\",\n            \"addr1\": \"479 Mukim 13\",\n            \"addr2\": \"Persiaran Sungai Dua\",\n            \"addr3\": \"\",\n            \"addr4\": \"\",\n            \"postcode\": \"23000\",\n            \"city\": \"Gelugor\",\n            \"state\": \"Terengganu\",\n            \"country\": \"Malaysia\"\n        },\n        \"fromBranch\": \"\",\n        \"toBranch\": \"\",\n        \"currency\": \"MYR\",\n        \"price\": 5.9,\n        \"tracking_code\": \"\",\n        \"verify_code\": \"\",\n        \"parcel_number\": \"PPUHTDG7VQ\"\n    }\n}\n
","urlObject":{"protocol":"https","path":["public","order"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"95eafd1e-1f6b-5423-9607-1d9c71f55f46"},{"name":"Pay Order - v1","id":"06131010-6bab-f34d-4df7-71a59e277d20","request":{"method":"POST","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://public-api-sandbox.pgeon.delivery/public/order/{order_number}/pay","description":"

Pay the order that you make with MakeOrder end point
\n
\nHeader
\napikey : (your api key), required
\nContent-Type : application/json, required
\n
\n URL Param
\norder_number : required
\nExample: public-api-sandbox.pgeon.delivery/public/order/PO123456/pay\n
\n
\nResponse Example

\n
\n{\n    \"status_code\": 200,\n    \"error\": {\n        \"message\": \"Successful pay for order [ POOAFGM0I4 ]\"\n    },\n    \"data\": {\n        \"awb\": \"EPUW4AMH\",\n        \"awb_url\": \"http://public-api-dev.pgeon.delivery/public/pdf/EPUW4AMH\",\n        \"verify_code\": null,\n        \"parcel_number\": \"PPUHTDG7VQ\",\n        \"from\": {\n            \"city\": \"Gelugor\",\n            \"addr1\": \"321 Mukim 123\",\n            \"addr2\": \"Persiaran Sungai Dua\",\n            \"addr3\": \"\",\n            \"addr4\": \"\",\n            \"state\": \"07\",\n            \"country\": \"my\",\n            \"postcode\": \"11800\",\n            \"route_code\": \"MY-G-136D\"\n        },\n        \"to\": {\n            \"city\": \"Gelugor\",\n            \"addr1\": \"479 Mukim 13\",\n            \"addr2\": \"Persiaran Sungai Dua\",\n            \"addr3\": \"\",\n            \"addr4\": \"\",\n            \"state\": \"11\",\n            \"country\": \"my\",\n            \"postcode\": \"23000\",\n            \"route_code\": \"MY-ZK-286D\"\n        }\n    }\n}\n
","urlObject":{"protocol":"https","path":["public","order","{order_number}","pay"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"06131010-6bab-f34d-4df7-71a59e277d20"},{"name":"Bulk Pay Order - v1","id":"bfe149ab-2e9a-44e8-b32c-6269c9020fb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"apikey","value":""}],"body":{"mode":"raw","raw":"{\n\t\"order_number\": [\n\t\t\"POBNHTEHP6\",\n\t\t\"POBNHTERTA\"\n\t]\n}"},"url":"http://public-api-sandbox.pgeon.delivery/public/order/pay/bulk","description":"

Pay the order that you make with MakeOrder end point
\n
\nHeader
\napikey : (your api key), required
\nContent-Type : application/json, required
\n
\n Body
\norder_number : required, array
\n
\n
\nResponse Example

\n
\n{\n    \"status_code\": 200,\n    \"error\": {\n        \"message\": \"\"\n    },\n    \"data\": {\n        \"success_order\": [\n            {\n                \"parcel_number\": \"PP0KONJ1R4\",\n                \"order_number\": \"POW22WXXOF\",\n                \"awb\": \"K7K76J\",\n                \"verify_code\": null,\n                \"from\": {\n                    \"addr1\": \"32,Lrg Machang Bubuk 18, Taman Machang Bubuk\",\n                    \"addr2\": \"\",\n                    \"addr3\": \"\",\n                    \"addr4\": \"\",\n                    \"postcode\": \"14020\",\n                    \"city\": \"Bukit Mertajam\",\n                    \"state\": \"07\",\n                    \"country\": \"my\",\n                    \"id\": \"114005\",\n                    \"route_code\": \"PEN-SGR-P\"\n                },\n                \"to\": {\n                    \"addr1\": \"jalan\",\n                    \"addr2\": \"\",\n                    \"addr3\": \"\",\n                    \"addr4\": \"\",\n                    \"postcode\": \"55100\",\n                    \"city\": \"KUALA LUMPUR\",\n                    \"state\": \"14\",\n                    \"country\": \"my\",\n                    \"id\": \"114006\",\n                    \"route_code\": \"PEN-SGR-ZK\"\n                },\n                \"awb_url\": \"http://public-api-sandbox.pgeon.delivery/public/pdf/K7K76J\"\n            }\n        ],\n        \"fail_order\": []\n    }\n}\n
","urlObject":{"protocol":"http","path":["public","order","pay","bulk"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"bfe149ab-2e9a-44e8-b32c-6269c9020fb7"},{"name":"Make and Pay Order - v2","id":"d3975659-b67c-49c6-a774-8dec309efac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"apikey","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"bulk\": [\n {\n \"id\": \"someRandomUniqueString\",\n \"service_type\": \"d2d\",\n \"phone_number\": \"0123456780\",\n \"phone_country\": \"my\",\n \"sender_name\": \"test bot\",\n \"sender_phone_number\": \"0123456786\",\n \"sender_phone_country\": \"my\",\n \"receiver_name\": \"test bot\",\n \"receiver_phone_number\": \"0123456782\",\n \"receiver_phone_country\": \"my\",\n \"parcel_weight\": 23,\n \"parcel_content\": \"gold\",\n \"parcel_value\": \"100\",\n \"sender_addr1\": \"28, Jalan Testing 56\",\n \"sender_addr2\": \"\",\n \"sender_addr3\": \"\",\n \"sender_addr4\": \"\",\n \"sender_postcode\": \"79230\",\n \"sender_city\": \"somecity\",\n \"sender_state\": \"01\",\n \"sender_country\": \"my\",\n \"receiver_addr1\": \"223, Jalan Failing 1\",\n \"receiver_addr2\": \"\",\n \"receiver_addr3\": \"\",\n \"receiver_addr4\": \"\",\n \"receiver_postcode\": \"62700\",\n \"receiver_city\": \"somecity\",\n \"receiver_state\": \"16\",\n \"receiver_country\": \"my\",\n \"from_point\": \"\",\n \"to_point\": \"\",\n \"awb_number\": \"yourCustomAWB\",\n \"collection_date\": \"2020-10-10\"\n }\n ]\n}"},"url":"https://public-api-sandbox.pgeon.delivery/public/place-order","description":"

Create orders and pay orders in one API call.

\n

Recommend to use this endpoint to place order with Pgeon as this is the optimized and confirmed booked endpoint. as Make Order and Pay Order separate endpoint is designed if your platform is similar with EasyParcel

\n

Header

\n

apikey : (your api key), required

\n

Content-Type : application/json, required

\n

Body

\n

Fill in the body content according below example base on the service you want to perform.

\n

id : required, unique (For req and res mapping)

\n

service_type : p2p|p2d|d2p|d2d, required

\n

sender_name : required, more than 3 character

\n

sender_phone_number : required

\n

sender_phone_country : required

\n

sender_email : required

\n

receiver_name : required

\n

receiver_phone_number : required

\n

receiver_phone_country : required

\n

receiver_email : required

\n

sender_addr1 : required for d2p,d2d

\n

sender_addr2 : optional

\n

sender_addr3 : optional

\n

sender_addr4 : optional

\n

sender_postcode : required

\n

sender_city : required

\n

sender_state : required, ISO 3166-2 format

\n

sender_country : required, ISO 3166 format

\n

receiver_addr1 : required for p2d, d2d

\n

receiver_addr2 : optional

\n

receiver_addr3 : optional

\n

receiver_addr4 : optional

\n

receiver_postcode : required

\n

receiver_city : required

\n

receiver_state : required, ISO 3166-2 format

\n

receiver_country : required, ISO 3166 format

\n

parcel_weight : required

\n

parcel_content : required

\n

parcel_value : required

\n

collection_date : optional

\n

from_point : required for p2p,p2d

\n

to_point : required for p2p,d2p

\n

awb_number : optional, for using your own awb

\n

is_cod: optional, boolean, true if it is COD shipment

\n

cod_detail: required when is_cod is true, object

\n

cod_detail.currency: required when is_cod is true, 3 char code

\n

cod_detail.amount: required when is_cod is true, numeric

\n

Response Example

\n
{\n    \"status_code\": 200,\n    \"error\": {\n        \"message\": \"\"\n    },\n    \"data\": {\n        \"success_order\": [\n            {\n                \"id\": \"someRandomUniqueString\",\n                \"parcel_number\": \"PPWRLN8V2W\",\n                \"order_number\": \"PO3Q20ANN1\",\n                \"transaction_no\": \"TTKODFP166\",\n                \"awb\": \"N6427247119009\",\n                \"awb_url\": \"https://public-api-sandbox.pgeon.delivery/public/pdf/N6427247119009\",\n                \"verify_code\": null,\n                \"from\": {\n                    \"addr1\": \"28, Jalan Testing 56\",\n                    \"addr2\": \"\",\n                    \"addr3\": \"\",\n                    \"addr4\": \"\",\n                    \"postcode\": \"79230\",\n                    \"city\": \"somecity\",\n                    \"state\": \"01\",\n                    \"country\": \"my\",\n                    \"route_code\": \"JHB-301\"\n                },\n                \"to\": {\n                    \"addr1\": \"223, Jalan Failing 1\",\n                    \"addr2\": \"\",\n                    \"addr3\": \"\",\n                    \"addr4\": \"\",\n                    \"postcode\": \"62700\",\n                    \"city\": \"somecity\",\n                    \"state\": \"16\",\n                    \"country\": \"my\",\n                    \"route_code\": \"JHB-301\"\n                }\n            }\n        ],\n        \"fail_order\": []\n    }\n}\n\n
","urlObject":{"protocol":"https","path":["public","place-order"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3975659-b67c-49c6-a774-8dec309efac4"},{"name":"Cancel Order","id":"4cc6a5c5-ae80-3756-73b8-1f7e050a4ea7","request":{"method":"DELETE","header":[{"key":"apikey","value":""}],"url":"https://public-api-sandbox.pgeon.delivery/public/order/{order_number}","description":"

Cancel user order, only paid order can cancel
\n
\nHeader
\napikey : (your api key), required
\nContent-Type : application/json, required
\n
\n URL
\norder_number : required
\nExample: public-api-sandbox.pgeon.delivery/public/order/PO123456

\n","urlObject":{"protocol":"https","path":["public","order","{order_number}"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"4cc6a5c5-ae80-3756-73b8-1f7e050a4ea7"},{"name":"List Order","id":"9a849ca1-c02b-c80c-3849-72b1a302631f","request":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://public-api-sandbox.pgeon.delivery/public/order","description":"

List orders
\n
\nHeader
\napikey : (your api key), required
\nContent-Type : application/json, required
\n
\n Get Parameter
\ncurrent_page : optional, default 1, min 1
\nlimit : optional, item per page, default 10, max 100

\n","urlObject":{"protocol":"https","path":["public","order"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a849ca1-c02b-c80c-3849-72b1a302631f"},{"name":"Get Order","id":"436dbce7-5872-48f7-ba3a-f93474b1036e","request":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://public-api-sandbox.pgeon.delivery/public/order/{order_number}","description":"

List orders
\n
\nHeader
\napikey : (your api key), required
\nContent-Type : application/json, required
\n
\nResponse Example

\n
\n{\n    \"status_code\": 200,\n    \"error\": {\n        \"message\": \"Successful get order\"\n    },\n    \"data\": {\n        \"parcel\": {\n            \"order_type\": \"\",\n            \"price\": \"5.90\",\n            \"currency\": \"MYR\",\n            \"status\": \"Paid\",\n            \"app_order_number\": \"POOAFGM0I4\",\n            \"item_list\": [\n                {\n                    \"tracking_code\": \"EPUW4AMH\",\n                    \"verify_code\": null,\n                    \"service_type\": \"D2D\",\n                    \"parcel_number\": \"PPUHTDG7VQ\",\n                    \"parcel_weight\": \"0.10\",\n                    \"parcel_content\": \"gold\",\n                    \"parcel_value\": \"10.00\",\n                    \"price\": \"5.90\",\n                    \"currency\": \"MYR\",\n                    \"cod_payment_status\": null,\n                    \"created_at\": \"2019-02-26T03:00:14.000Z\",\n                    \"awb_url\": \"http://public-api-dev.pgeon.delivery/public/pdf/EPUW4AMH\",\n                    \"fromBranch\": null,\n                    \"toBranch\": null,\n                    \"fromAddress\": \"321 Mukim 123 Persiaran Sungai Dua 11800 Gelugor Pulau Pinang Malaysia \",\n                    \"toAddress\": \"479 Mukim 13 Persiaran Sungai Dua 23000 Gelugor Terengganu Malaysia \",\n                    \"from\": {\n                        \"city\": \"Gelugor\",\n                        \"addr1\": \"321 Mukim 123\",\n                        \"addr2\": \"Persiaran Sungai Dua\",\n                        \"addr3\": \"\",\n                        \"addr4\": \"\",\n                        \"state\": \"07\",\n                        \"country\": \"my\",\n                        \"postcode\": \"11800\",\n                        \"route_code\": \"MY-G-136D\"\n                    },\n                    \"to\": {\n                        \"city\": \"Gelugor\",\n                        \"addr1\": \"479 Mukim 13\",\n                        \"addr2\": \"Persiaran Sungai Dua\",\n                        \"addr3\": \"\",\n                        \"addr4\": \"\",\n                        \"state\": \"11\",\n                        \"country\": \"my\",\n                        \"postcode\": \"23000\",\n                        \"route_code\": \"MY-ZK-286D\"\n                    }\n                }\n            ]\n        }\n    }\n}\n
\n","urlObject":{"protocol":"https","path":["public","order","{order_number}"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"436dbce7-5872-48f7-ba3a-f93474b1036e"},{"name":"Get account credit","id":"813bcf07-bbd3-402f-a6fd-c12f1c5fb585","request":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://public-api-sandbox.pgeon.delivery/public/wallet","description":"

Get account credit
\n
\nHeader
\napikey : (your api key), required
\nContent-Type : application/json, required
\n

\n","urlObject":{"protocol":"https","path":["public","wallet"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"813bcf07-bbd3-402f-a6fd-c12f1c5fb585"},{"name":"Get consignment note (PDF)","id":"07507b0b-9c5b-437e-887a-f9277ab2ec49","request":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://public-api-sandbox.pgeon.delivery/public/pdf/{awb}?page_size=A6","description":"

Get consignment note (PDF) / Air waybill

\n

Header

\n

apikey : (your api key), required

\n

Content-Type : application/json, required

\n

Get Parameter

\n

page_size : optional, A6 or A4, default A4

\n

Response Example (Pdf)

\n","urlObject":{"protocol":"https","path":["public","pdf","{awb}"],"host":["public-api-sandbox","pgeon","delivery"],"query":[{"key":"page_size","value":"A6"}],"variable":[]}},"response":[],"_postman_id":"07507b0b-9c5b-437e-887a-f9277ab2ec49"},{"name":"Tracking","id":"44e2b3d7-dd0d-4fee-abec-36e07d9743e5","request":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://public-api-sandbox.pgeon.delivery/public/tracking/{awb}","description":"

Tracking API that giving airway bill numbers and it will return a set of tracking results.

\n

Response Example

\n
{\n    \"status_code\": 200,\n    \"error\": {\n        \"message\": \"Result retrieved\"\n    },\n    \"data\": [\n        {\n            \"code\": \"14\",\n            \"tracking_code\": \"N6089546119009\",\n            \"description\": \"Parcel has shipped out from sorting hub\",\n            \"location\": \"Bayan Lepas\",\n            \"is_return\": false,\n            \"timestamp\": \"2021-12-07T06:36:49.000Z\"\n        },\n        {\n            \"code\": \"13\",\n            \"tracking_code\": \"N6089546119009\",\n            \"description\": \"Checked in into Bayan Lepas hub\",\n            \"location\": \"Bayan Lepas\",\n            \"is_return\": false,\n            \"timestamp\": \"2021-12-07T06:36:38.000Z\"\n        },\n        {\n            \"code\": \"1\",\n            \"tracking_code\": \"N6089546119009\",\n            \"description\": \"Order created (2021-12-08)\",\n            \"location\": \"\",\n            \"is_return\": false,\n            \"timestamp\": \"2021-12-07T06:34:16.000Z\"\n        }\n    ]\n}\n

Header

\n

apikey : (your api key), required

\n

Content-Type : application/json, required

\n

Remark

\n

Rate limit 60 request per minute

\n

Sample of response and explanation
\"tracking_code\" = awb number, consignment note number.
\"code\" = status code of that particular tracking message.

\n

Status Code description

\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\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\n\n
CodeDescription
1Order is received
2Parcel drop off at pgeon point
3Parcel has been collected at pgeon point
4Parcel arrived at pgeon point
5Receiver collected parcel at pgeon point
6Sender taken back parcel at pgeon point
7Recollect courier parcel at pgeon point
8Courier take back parcel from pgeon point
9Receiver put back the parcel at pgeon point
10Out of Collection
11Collection attempted
12Collected
13Arrived Pgeon Hub
14Ready to ship out from sorting hub
153pl tracking status
17Out for delivery
18Delivery attempted
19Delivered recipient
20On Hold
25Return is initiated
30Returned to sender
\n
","urlObject":{"protocol":"https","path":["public","tracking","{awb}"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"44e2b3d7-dd0d-4fee-abec-36e07d9743e5"},{"name":"Get Rate","id":"e070a8a0-94a6-d3a5-811a-8d09422fa44f","request":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://public-api-sandbox.pgeon.delivery/public/rate?from_postcode=11900&from_country=MY&to_postcode=11900&to_country=MY&service=DD&weight=1","description":"

Get shipment rate

\n

Response Example

\n
{\n    \"status_code\": 200,\n    \"error\": {\n        \"message\": \"\"\n    },\n    \"data\": {\n        \"price\": 5.9,\n        \"currency\": \"MYR\"\n    }\n}\n\n
\n

Get Parameter

\n

Fill in as GET parameter according below example base on the service you want to perform.

\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\n\n\n\n\n
Namerequireddescription
servicetruePP, DP, PD, DD
PP - Point to Point
PD - Point to Door
DP - Door to Point
DD - Door to Door
from_pointtruerequired if service is PP, PD
to_pointtruerequired if service is PP, DP
from_postcodetruerequired if service is DP, DD
from_countrytruerequired if service is DP, DD
to_postcodetruerequired if service is PD, DD
to_countrytruerequired if service is PD, DD
weighttrueweight in KG
\n
","urlObject":{"protocol":"https","path":["public","rate"],"host":["public-api-sandbox","pgeon","delivery"],"query":[{"key":"from_postcode","value":"11900"},{"key":"from_country","value":"MY"},{"key":"to_postcode","value":"11900"},{"key":"to_country","value":"MY"},{"key":"service","value":"DD"},{"key":"weight","value":"1"}],"variable":[]}},"response":[],"_postman_id":"e070a8a0-94a6-d3a5-811a-8d09422fa44f"},{"name":"Update COD Payment","id":"fd74b9fb-4c6e-211c-c064-00826ea0a59d","request":{"method":"PUT","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://public-api-sandbox.pgeon.delivery/public/parcel/{parcel_number}/cod","description":"

Update COD payment status in order to release the parcel to customer
\n
\nHeader
\napikey : (your api key), required
\nContent-Type : application/json, required
\n

\n","urlObject":{"protocol":"https","path":["public","parcel","{parcel_number}","cod"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd74b9fb-4c6e-211c-c064-00826ea0a59d"},{"name":"Get Courier List","id":"81067f49-2d14-48fd-acec-f0e45173b4e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"apikey","value":""}],"body":{"mode":"raw","raw":""},"url":"https://public-api-sandbox.pgeon.delivery/public/courier","description":"

This is the endpoint that will required if you want to make the order for pgeon point service only without the delivery.

\n","urlObject":{"protocol":"https","path":["public","courier"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"81067f49-2d14-48fd-acec-f0e45173b4e3"},{"name":"Get Coverage","id":"10dc4e9b-7e0c-472c-a811-943685bb9385","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"apikey","value":"","type":"text"}],"url":"https://public-api-sandbox.pgeon.delivery/public/coverage","description":"

This is the endpoint that will required if you want to get the coverage of pgeon delivery.

\n","urlObject":{"protocol":"https","path":["public","coverage"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"10dc4e9b-7e0c-472c-a811-943685bb9385"},{"name":"Subscribe webhook","id":"85a5f583-d808-4cf9-a63a-f039a9105963","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"apikey","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"webhook\": {\n\t\t\"url\": \"https://www.example.com\",\n\t\t\"topic\": \"shipment/tracking/create\"\n\t}\n}"},"url":"https://public-api-sandbox.pgeon.delivery/public/webhook","description":"

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

\n\n

Webhook topic

\n

  1. shipment/create

    1. trigger when the shipment is created

  2. shipment/status/update

    1. trigger when the shipment status is updated

  3. shipment/tracking/create

    1. trigger when new tracking record is created

  4. shipment/pod/create

    1. trigger when POD is uploaded

\n\n \n

Remark

\n

1. status code 200 mean successful subscribe webhook

\n

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

\n

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

\n

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

\n

Verify a Webhook created through the API

\n

Webhooks created through the API by Pgeon can be verified by calculating a digital signature.
Each Webhook request includes a Pgeon-Signature header which is generated using
the client apikey, along with the data sent in the request.

\n

To verify that the HTTP request came from Pgeon, compute the HMAC digest according to the following algorithm and compare it to the value in the Pgeon-Signature header. If they match, you can be sure that the Webhook was sent from Pgeon and the data has not been compromised.

\n

A simple webhook verification example in NodeJS is shown below.

\n
function verify_webhook()\n{\n    let hash = crypto.createHmac('sha256', your_api_key);\n    hash.update(JSON.stringify(post_body));\n    return headers['Pgeon-Signature'] === hash.digest('base64');\n}\n\n
","urlObject":{"protocol":"https","path":["public","webhook"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"85a5f583-d808-4cf9-a63a-f039a9105963"},{"name":"Multiple Parcel Shipment","id":"9cc09ee1-ae7f-4ebf-a9fb-ebd9cb54f314","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"apikey","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"service_type\": \"mps\",\n \"sender_name\": \"Testing\",\n \"sender_phone_number\": \"60123456789\",\n \"sender_phone_country\": \"MY\",\n \"sender_email\": \"\",\n \"receiver_name\": \"Testing\",\n \"receiver_phone_number\": \"60123456789\",\n \"receiver_phone_country\": \"MY\",\n \"receiver_email\": \"\",\n \"sender_addr1\": \"no 10 Jalan Testing\",\n \"sender_addr2\": \"\",\n \"sender_addr3\": \"\",\n \"sender_addr4\": \"\",\n \"sender_postcode\": \"47130\",\n \"sender_city\": \"Test\",\n \"sender_country\": \"my\",\n \"receiver_addr1\": \"no 10 Jalan Testing\",\n \"receiver_addr2\": \"\",\n \"receiver_addr3\": \"\",\n \"receiver_addr4\": \"\",\n \"receiver_postcode\": \"51000\",\n \"receiver_city\": \"Test\",\n \"receiver_country\": \"my\",\n \"collection_date\": \"\",\n \"parcel\": [\n {\n \"id\": \"customer reference\",\n \"parcel_weight\": 2,\n \"parcel_content\": \"book\",\n \"parcel_value\": 10\n },\n {\n \"id\": \"customer reference\",\n \"parcel_weight\": 3,\n \"parcel_content\": \"book\",\n \"parcel_value\": 110\n },\n {\n \"id\": \"customer reference\",\n \"parcel_weight\": 4,\n \"parcel_content\": \"book\",\n \"parcel_value\": 20\n },\n {\n \"id\": \"customer reference\",\n \"parcel_weight\": 7,\n \"parcel_content\": \"book\",\n \"parcel_value\": 300\n },\n {\n \"id\": \"customer reference\",\n \"parcel_weight\": 10,\n \"parcel_content\": \"book\",\n \"parcel_value\": 90\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://public-api-sandbox.pgeon.delivery/public/multiple-parcel/place-order","description":"

Body

\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\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\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\n\n\n
Namerequireddescription
service_typetrueput \"mps\" in this field
sender_nametrue
sender_phone_countrytruesender phone country iso code, eg: MY, SG, CN, HK
sender_phone_numbertrue
sender_emailfalse
receiver_nametrue
receiver_phone_numbertrue
receiver_phone_countrytruereceiver phone country iso code, eg: MY, SG, CN, HK
receiver_emailfalse
sender_addr1true
sender_addr2false
sender_postcodetrue
sender_citytrue
sender_statefalse
sender_countrytrueiso code, eg: MY, SG, CN
receiver_addr1true
receiver_addr2false
receiver_citytrue
receiver_statefalse
receiver_countrytrueiso code, eg: MY, SG, CN
collection_datefalsedefault will be next working day
parceltruearray of object
parcel.*.idfalsefor customer mapping result
parcel.*.parcel_weighttrue
parcel.*.parcel_contecttrue
parcel.*.parcel_valuetrue
\n

Response Example

\n
{\n    \"status_code\": 200,\n    \"error\": {\n        \"message\": \"\"\n    },\n    \"data\": {\n        \"mother_awb\": \"MPSF877H\",\n        \"price\": 120,\n        \"currency\": \"MYR\",\n        \"weight\": 26,\n        \"parcel_count\": 5,\n        \"parcel\": [\n            {\n                \"id\": \"OADSCA\",\n                \"child_awb\": \"MPSF877H001\",\n                \"order_number\": \"POJPM82Q0X\",\n                \"weight\": 2\n            },\n            {\n                \"id\": \"LDASCLOA\",\n                \"child_awb\": \"MPSF877H002\",\n                \"order_number\": \"PO3A50HJQZ\",\n                \"weight\": 3\n            },\n            {\n                \"id\": \"LOASDCA\",\n                \"child_awb\": \"MPSF877H003\",\n                \"order_number\": \"POWE588IR3\",\n                \"weight\": 4\n            },\n            {\n                \"id\": \"LJDCAASC\",\n                \"child_awb\": \"MPSF877H004\",\n                \"order_number\": \"POP4GS20TU\",\n                \"weight\": 7\n            },\n            {\n                \"id\": \"LNASCKNA\",\n                \"child_awb\": \"MPSF877H005\",\n                \"order_number\": \"PO5KFJANUF\",\n                \"weight\": 10\n            }\n        ]\n    }\n}\n\n
\n","urlObject":{"protocol":"https","path":["public","multiple-parcel","place-order"],"host":["public-api-sandbox","pgeon","delivery"],"query":[],"variable":[]}},"response":[],"_postman_id":"9cc09ee1-ae7f-4ebf-a9fb-ebd9cb54f314"}],"event":[{"listen":"prerequest","script":{"id":"ae647790-f33b-4859-a7e9-6577259a2479","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7dd0e80c-419c-4fea-92bf-a529a47dade6","type":"text/javascript","exec":[""]}}]}