You are on page 1of 5

_____________________________________________________________________________________

Tezz Courier API Guide


TezzPK API Guide has following API’S

 Create Order API: This API will be used to create Order over the Courier Web App.
You will provide User Authentication key with some necessary details to save data
 Get Orders List API: This API will respond order data against single user account.
 Track Order API: This API will be used to Track Orders History.
 Cancel Order API: This API will be used to Cancel Customer Orders.
_____________________________________________________________________________________
Create Order API
 URL : https://www.tezzpk.com/API/CreateOrder.php

 Type: POST (JSON Format)


 Response: application/JSON
 Parameters:

Parameter Description Example


auth_key Specific User Authentication KEY 2b4265f0-6b5a-4105-bh70-l74cce97bi06

service_type Type of order service Cash On Delivery

order_date Order Date Y-m-d

origin Package pickup city Riyadh

destination Package delivered city LAHORE

receiver_name Name of Receiver Ahmed Jahanzaib

receiver_phone Contact No of Receiver 923001234567

receiver_email Receiver email user@gmail.com

receiver_address Address of Receiver xyz

pieces Quantity of Parcel 5

weight Weight of Parcel (in kg) 2

collection_amount Collection Amount 1200

product_description Ititem details xyz

special_instruction Special Instruction xyz


_____________________________________________________________________________________
Sample POST JSON format:

{
"auth_key":"5ab195a0-0617-4306-93f8-dc75c04fb5e2",
"service_type":"Cash On Delivery",
"order_date":"2020-07-14",
"origin":"Lahore",
"destination":"Islamabad",
"receiver_name":"Test",
"recei ver_phone":"1234555",
"receiver_email":"test@gmail.com",
"receiver_address":"test address",
"pieces":"12",
"weight":"2.5",
"collection_amount":"1200",
"product_description":"descrption",
"special_instruc tion":"instruction"
}
Response Data

Order 60000123 created successfully

Get Orders API


URL : https://www.tezzpk.com/API/GetOrderList.php?auth_key=2bu265f0-6g5a-4105-bh70-
l74cce97bi06

 Type: GET
 Response: application/Json 
Parameters:
_____________________________________________________________________________________

Get Orders API


URL : https://www.tezzpk.com/API/GetOrderList.php

 Type: POST
 Response: application/Json
 Parameters:
Parameter Description Example
auth_key Specific Customer Authentication Key 2bu265f0-6g5a-4105-bh70-l74cce97bi06

Limit Specify limit of the records 10

Sample POST JSON format:


{
"auth_key":"5ab195a0-0617-4306-93f8-dc75c04fb5e2",
"limit":"10"
}
Success Response:{"response":1,"result":array, "message":" All orders List."}
Error Response:{"response":0"message":"No record found."}
Data-return:
Whole data from “order” table with the described limit with latest record on top

Track Orders API


URL : https://www.tezzpk.com/API/TrackOrder.php?tracking_no= 20111378

 Type: GET
 Response: application/Json
Parameter Description Example
tracking_no Order Tracking Number 20000123,20000124
_____________________________________________________________________________________
Cancel Order Api
URL : https://www.tezzpk.com/API/CancelOrder.php

 Type: POST
 Response: application/Json
 Parameters:{order information}
 Only order with status “New Booked” can be canceled.
Parameter Description Example
tracking_no Order Tracking Number 20000123

auth_key Specific Customer Authentication Key 2bu265f0-6g5a-4105-bh70-l74cce97bi06

Sample POST JSON format:


{
"auth_key":"5ab195a0-0617-4306-93f8-dc75c04fb5e2",
" tracking_no":" 20111378"
}

You might also like