ParcelPort System API(v1.0)

Parcel Port API provides an access to enable your customer to send parcels using our system.

---

Live URL: https://api.parcelport.co.nz Test URL: https://apitest.parcelport.co.nz

Get token

Allows third-party systems to get Payport customers’ API authorization token from Payport System. The token will expire in 30Mins

URL: https://api.parcelport.co.nz/token

Required Parameters:

• username [Require]
• password [Require]
• grant_type [Require]

Example

Request POST https://api.parcelport.co.nz/token

Headers Content-Type: application/json;

x-www-form-urlencoded

{
    username:"Test"
    password:"Password"
    grant_type: "password"
}

Responses

{
    "access_token": "U995BbNx_JQZPozAd6QZPBUc6M7PMwXQUMS_dU42IJ-bDd635VLC1q-ksDO2EnUCsJvo6hrFiiE_KkXcsDOguj1wISMudM45DTWNwE9E-4Ik0DdK6e-U-KU8CSdXyD8K0lJArHMpff7m1DWIV0OgBDY73S7w18P12ygXRZBcbiwkynQpKwDgR6WzQouTmSOoXcwYajV8aDo7fKNqyDn32n7hY79ADz8-yfRUK_f7_ynIvvyuoJI43NsFNy46d4YYjD9zyU-rz0tu-kTVkWfq4zVT3msOfiMZCSkCPgUuOeXvglsf-iyktWZZRAg4p1cEVVc3-Wo0wRuuMwqoA0Dx_Q",
    "token_type": "bearer",
    "expires_in": 1799,
    "client_id": "187",
    "userName": "test",
    ".issued": "Thu, 30 Aug 2018 23:31:53 GMT",
    ".expires": "Fri, 31 Aug 2018 00:01:53 GMT"
} 

---

Shipping

• POST /api/1.0/shippingoptions returns a list of available shipping methods

Make a consignment

• PUT /api/1.0/consignment Put a consignment

Label

• GET /api/1.0/labels Get a url of label(PDF)

Booking

• POST /api/1.0/bookings Booking a pickup time

Tracking

• GET /api/1.0/tracking Get tracking history of the consignment

Third Party orders

• PUT /api/1.0/thirdpartyorders Put a list of third party orders