Contents

a. Pre-Requisites.......................................................................................................................................................................
1. Orders List API......................................................................................................................................................................
2. Order Track API....................................................................................................................................................................
3. Order Status Timeline API.................................................................................................................................
4. Cities API............................................................................................................................................................
5. Pickup Locations API........................................................................................................................................
6. Order Store API.....................................................................................................................................................................
7. Cancel Order API..................................................................................................................................................................
8. Advice List (Pending for Remark) API...................................................................................................................................
9. Advice List (Remark Submitted but not Approved) API........................................................................................................
10. Advice List (Remark Submitted and Approved) API............................................................................................................
11. Add Remark API..................................................................................................................................................................
a. Pre-Requisites

URL: https://portal.dodeliver.com

HOW TO GET API AUTHORIZATION KEY

brand name).

On the header section of the portal, go for the Api Key option at the top-right (by clicking on the

Upon clicking, the Api Key screen will be opened, where the API key can be seen at the top, which
you can copy to use for authorization purposes or you can roll api key which will change api key.

And below api key there is a table or available services with amount for parcel.

1. Orders List API

URL: https://portal.dodeliver.com.pk/ api/orders

METHOD -> GET

QUERY PARAMETERS

Input Description
api_key API Key to be provided individually
tracking_ids[] order tracking id (optional) (multiple can be used like
tracking_id[]=111111&traking_id[]=222222)
take limit orders (optional by default 2000) (for pagination purpose)

skip skip orders (optional by default 0) (for pagination purpose)

RESULT

{
"status": true,

"totalOrderCount": 91112,

"orderCount": 100,

"skip": "0",

"take": "100",

"orders": [

"id": 1,

"tracking_id": 10000001,

"user_id": 2,

"name": "Zara",

"customer_name": "Test",

"email": null,

"phone": "3231234456",

"phone_alternate": null,

"delivery_address": "test1",

"area": null,

"city": "Lahore",

"product": "Test Order",

"customer_reference": "ORDER NO 121",

"quantity": 1,

"weight": 2,

"amount": 1000,

"delivery_type_id": 2,

"status_id": 12,

"order_time": "2022-03-31 02:38:47",

"estimated_delivery_time": "2022-04-02 21:38:47",

 "fragile": 0,

"received_by": null,

"mentions": null,

"additional_info": "-",
"attempt": 0,

"is_deleted": "0",

"created_at": "2022-03-31T00:38:47.000000Z",

"updated_at": "2022-12-21T10:34:40.000000Z",

"replace_id": 0

},

"id": 2,

"tracking_id": 10000002,

"user_id": 2,

"name": "Zara",

"customer_name": "Test",

"email": null,

"phone": "3231234456",

"phone_alternate": null,

"delivery_address": "test2",

"area": null,

"city": "Karachi",

"product": "Test Order",

"customer_reference": "ORDER NO 122",

"quantity": 1,

"weight": 2,

"amount": 2000,

"delivery_type_id": 1,
 "status_id": 12,

"order_time": "2022-03-31 02:38:47",

"estimated_delivery_time": "2022-04-02 21:38:47",

"fragile": 0,

"received_by": null,
"mentions": null,

"additional_info": "-",

"attempt": 0,

"is_deleted": "0",

"created_at": "2022-03-31T00:38:47.000000Z",

"updated_at": "2022-12-21T10:34:40.000000Z",

"replace_id": 0

2. Order Track API

URL: https://portal.dodeliver.com.pk/ api/orders/[Tracking-ID]

METHOD -> GET

ROUTE PARAMETERS

Input Description

Tracking-ID Tracking ID of Order which you want to track

RESULT

{
"timeline": [
{
"date": "31 Mar, 2022 - Thu",
 "status": [
{
"time": "00:38 AM",
"name": "dodeliver",
"log": "Order placed to DoDeliver"
},
{
"time": "00:45 AM",
"name": "dodeliver",
"log": "Order has been assigned to Test-03232565198-karachi"
},
{
"time": "00:46 AM",
"name": "dodeliver",
"log": "Order status changed to Out for Delivery"
},
{
"time": "00:47 AM",
"name": "dodeliver",
"log": "Order status changed to Delivered"
}
]
},
{
"date": "12 Dec, 2022 - Mon",
"status": [
{
"time": "05:06 AM",
"name": "dodeliver",
"log": "Order has been assigned to Salman-03150225150-Karachi"
}
]
},
{
"date": "21 Dec, 2022 - Wed",
"status": [
{
"time": "10:34 AM",
"name": "Zara",
"log": "Order status changed to Cancelled"
}
]
}
],
 "status": true,
"message": "Order Detail found",
"order_detail": {
"id": 1,
"tracking_id": 10000001,
"user_id": 2,
"name": "Zara",
"customer_name": "Test",
"email": null,
"phone": "3231234456",
"phone_alternate": null,
"delivery_address": "test1",
"area": null,
"city": "Lahore",
"product": "Test Order",
"customer_reference": "ORDER NO 121",
"quantity": 1,
"weight": 2,
"amount": 1000,
"delivery_type_id": 2,
"status_id": 12,
"order_time": "2022-03-31 02:38:47",
"estimated_delivery_time": "2022-04-02 21:38:47",
"fragile": 0,
"received_by": null,
"mentions": null,
"additional_info": "-",
"attempt": 0,
"is_deleted": "0",
"created_at": "2022-03-31T00:38:47.000000Z",
"updated_at": "2022-12-21T10:34:40.000000Z",
"replace_id": 0
}
}

3. Bulk Order Track API

https://portal.dodeliver.com.pk/track/orders

METHOD -> POST

QUERY PARAMETERS
 Input Description

api_key API Key to be provided individually

BODY PARAMETERS

Input Description

tracking_ids array of order ids i.e. [1111111,2222222]

RESULT

"status": true,

"orders": [

"customer_name": "Amber Vadsaria",

"tracking_id": 10333971,

"service_name": "COD within the city",

"origin_city": "KARACHI",

"city": "KARACHI",

"product": "#1667845_1",

"customer_reference": "#1667845_1",

"quantity": 1,

"weight": "0.50",

"timeline": [

"date": "31 Aug, 2024 - Sat",

 "status": [

"time": "12:20 PM",

"name": "Saeed Ghani",

"log": "Order placed to DoDeliver"

},

"date": "03 Sep, 2024 - Tue",

"status": [

"time": "12:17 PM",

"name": "dodeliver",

"log": "Order has been self assigned to Hammad Ahmed"

},

"time": "12:17 PM",

"name": "dodeliver",

"log": "Order has been self assigned to Hammad Ahmed"

},

{
 "time": "12:17 PM",

"name": "dodeliver",

"log": "Order status changed to Picked up by Hammad Ahmed"

},

"time": "12:17 PM",

"name": "dodeliver",

"log": "Order status changed to Picked up by Hammad Ahmed"

},

"time": "12:18 PM",

"name": "dodeliver",

"log": "Order status changed to Arrived At Origin"

},

"time": "12:18 PM",

"name": "dodeliver",

"log": "Order status changed to Return Confirm"

},

"time": "12:19 PM",

"name": "dodeliver",
 "log": "Order has been assigned to Danish KHI"

},

"time": "13:53 PM",

"name": "dodeliver",

"log": "Order has been assigned to APP Test"

},

"time": "13:53 PM",

"name": "dodeliver",

"log": "Order has been assigned to Ahtisham Abbasi KHI"

},

"time": "14:16 PM",

"name": "dodeliver",

"log": "Order has been assigned to Saqib Ahmed KHI"

},

"time": "15:04 PM",

"name": "dodeliver",

"log": "Order has been assigned to APP Test"

},
 {

"time": "15:09 PM",

"name": "dodeliver",

"log": "Status Change to Return Out for delivery"

4. Order Finance Status (Bulk) API

https://portal.dodeliver.com.pk/order/finance_status

METHOD -> POST

QUERY PARAMETERS

Input Description

api_key API Key to be provided individually

BODY PARAMETERS

Input Description

tracking_ids array of order ids i.e. [1111111,2222222]

RESULT
{

"status": true,

"message": "Order Finance Status",

"order_detail": {

"is_delivered": 0,

"customer_name": "Amber Vadsaria",

"tracking_id": 10333971,

"service_name": "COD within the city",

"origin_city": "KARACHI",

"client_settled_date": null,

"transaction_no": null,

"city": "KARACHI",

"product": "#1667845_1",

"customer_reference": "#1667845_1",

"quantity": 1,

"weight": "0.50",

"cod_amount": 894,

"charges": 73,

"is_settled": false

}
5. Order Finance Status (Single) API

https://portal.dodeliver.com.pk/order/finance_status/[Tracking-ID]

METHOD -> GET

Route PARAMETERS

Input Description

Tracking-ID API Key to be provided individually

QUERY PARAMETERS

Input Description

api_key API Key to be provided individually

RESULT

"status": true,

"message": "Order Finance Status",

"order_detail": {

"is_delivered": 0,

"customer_name": "Amber Vadsaria",

"tracking_id": 10333971,

"service_name": "COD within the city",

"origin_city": "KARACHI",

"client_settled_date": null,

"transaction_no": null,

"city": "KARACHI",
 "product": "#1667845_1",

"customer_reference": "#1667845_1",

"quantity": 1,

"weight": "0.50",

"cod_amount": 894,

"charges": 73,

"is_settled": false

6. Order Status Timeline API

URL: https://portal.dodeliver.com.pk/api/orders-status/[Tracking-ID]

METHOD -> GET

ROUTE PARAMETERS

Input Description

Tracking-ID Tracking ID of Order which you want to track

RESULT
{

"status": true,

"message": "Order Status Timeline",

"timeline": [

{
 "name": "Booked",

"date": "2023-01-30",
"time": "15:46 PM"

},

"name": "Parcel Returned",

"date": "2023-02-08",

"time": "16:55 PM"

},

"name": "Return Confirm",

"date": "2023-01-31",

"time": "21:37 PM"

},

"name": "Out for Delivery",

"date": "2023-01-31",

"time": "14:42 PM"

},

"name": "Arrived At Origin",

"date": "2023-01-30",

"time": "16:24 PM"

},

"name": "Request for Reattempt",

"date": "2023-01-31",

"time": "15:29 PM"

}
7. Cities API

URL: https://portal.dodeliver.com.pk/ api/cities

METHOD -> GET

QUERY PARAMETERS

Input Description

search filter cities

i.e islam key wil filterout DAR-UL-ISLAM CO, ISLAMKOT,
ISLAMABAD, etc.

RESULT
{

"status": true,

"message": "896 citie(s) has been found",

"cities": [

"id": 357,

"name": "Faisalabad",

"value": "faisalabad",

"created_at": "2022-09-01T13:52:53.000000Z",

"updated_at": "2022-09-01T13:52:53.000000Z"

},

"id": 1257,

"name": "PARACHINAR",

"value": "parachinar",
 "created_at": "2022-12-17T12:03:34.000000Z",

"updated_at": "2022-12-17T12:03:34.000000Z"

8. Pickup Locations API

https://ddworking.developer-iu.xyz/api/pickup/locations

METHOD -> GET

QUERY PARAMETERS

Input Description

api_key API Key to be provided individually

RESULT
{

"status": true,

"message": "1 Pickup Locations(s) has been found",

"locations": [

"id": 79,

"user_id": 210,

"address": "PLOT NO C 42, SECTOR 6 F, MEHRAN TOWN, KORANGI INDUSTRIAL

AREA",

"area": "Korangi",

"city": "KARACHI",

"is_active": 1,

"created_at": "2024-06-27T12:49:00.000000Z",

"updated_at": "2024-06-29T15:58:01.000000Z"

}
 ]

9. Order Store API

URL: https://portal.dodeliver.com.pk/ api/order

METHOD -> POST

QUERY PARAMETERS

Input Description
api_key API Key to be provided individually

BODY PARAMETERS

Input Description
consignee_name Customer who will receive parcel
consignee_contact_no Customer Contact No.
consignee_address Customer Address where parcel will be deliver
area Customer Address Area
city Customer Address City
product_name Product ID of your website, Product Name or Article No. of product
service Service is parcel delivery type which you can get in Pre-Requisites
pieces Item quantity in parcel
cod Amount of Parcel which customer will pay at time of delivery
customer_reference Order ID of your own system/website for cross order tracking
weight Parcel weight
advice If Instruction available, it can be given here
pickup_location_id

RESULT

{
"status": true,

"message": "Order added Successfully...!",

"order": {

"id": 334010,

"tracking_id": 10334010,

"user_id": 210,

"name": "Saeed Ghani",

"customer_name": "Test 1",

"email": null,

"phone": "0311222222",

"phone_alternate": null,

"delivery_address": "address test",

"area": "area test",

"city": "karachi",

"product": "product_name test",

"customer_reference": "customer reference test",

"quantity": 1,

"weight": "1.50",

"amount": 1000,

"delivery_type_id": 1,

"status_id": 2,

"order_time": "2024-09-06 18:26:16",

"estimated_delivery_time": "2024-09-09 13:26:16",

"fragile": 0,

"received_by": null,

"mentions": null,

"additional_info": null,
"attempt": 0,

"is_deleted": "0",

"created_at": "2024-09-06T13:26:16.000000Z",

"updated_at": "2024-09-06T13:26:16.000000Z",

"replace_id": null,

"is_delivered": 0,

"cod_amount": 73,

"last_status_update_date": "2024-09-06",

"pickup_date": null,

"pickup_rider_id": null,

"last_rider_id": null,

"last_rider_assign_date": null,

"service_name": "COD within the city",

"status_name": "Booked",

"rider_name": null,

"pickup_rider_name": null,

"delivery_rider_id": null,

"delivery_rider_name": null,

"last_rider_name": null,

"last_internal_note": null,

"last_client_remark": null,

"last_rider_remark": null,

"delivery_date": null,

"origin_address": "PLOT NO C 42, SECTOR 6 F, MEHRAN TOWN, KORANGI INDUSTRIAL AREA",

"origin_area": "Korangi",

"origin_city": "KARACHI",

"est_weight": 1.5,
 "return_charges": null,

"fuel_flat_surcharge": null,

"fuel_flexible_surcharge": null,

"client_settled_date": null,

"transaction_no": null

10. Cancel Order API

URL: https://portal.dodeliver.com.pk/api/orders/cancel

METHOD -> POST

QUERY PARAMETERS

Input Description
api_key API Key to be provided individually

BODY PARAMETERS

Input Description
tracking_ids Array of Tracking ID of orders, which you want to cancel

RESULT

"status": true,

"message": "Selected Orders has been cancelled",

"orders": [

"id": 334010,

"tracking_id": 10334010,

"user_id": 210,

"name": "Saeed Ghani",

"customer_name": "Test 1",

"email": null,

"phone": "0311222222",

"phone_alternate": null,

"delivery_address": "address test",

"area": "area test",

"city": "karachi",

"product": "product_name test",

"customer_reference": "customer reference test",

"quantity": 1,

"weight": "1.50",

"amount": 1000,

"delivery_type_id": 1,

"status_id": 12,

"order_time": "2024-09-06 18:26:16",

"estimated_delivery_time": "2024-09-09 13:26:16",

"fragile": 0,

"received_by": null,

"mentions": null,

"additional_info": null,

"attempt": 0,
"is_deleted": "0",

"created_at": "2024-09-06T13:26:16.000000Z",

"updated_at": "2024-09-06T13:34:59.000000Z",

"replace_id": null,

"is_delivered": 0,

"cod_amount": 73,

"last_status_update_date": "2024-09-06T13:34:59.189449Z",

"pickup_date": null,

"pickup_rider_id": null,

"last_rider_id": null,

"last_rider_assign_date": null,

"service_name": "COD within the city",

"status_name": "Cancelled",

"rider_name": null,

"pickup_rider_name": null,

"delivery_rider_id": null,

"delivery_rider_name": null,

"last_rider_name": null,

"last_internal_note": null,

"last_client_remark": null,

"last_rider_remark": null,

"delivery_date": null,

"origin_address": "PLOT NO C 42, SECTOR 6 F, MEHRAN TOWN, KORANGI INDUSTRIAL AREA",

"origin_area": "Korangi",

"origin_city": "KARACHI",

"est_weight": 1.5,

"return_charges": null,
 "fuel_flat_surcharge": null,

"fuel_flexible_surcharge": null,

"client_settled_date": null,

"transaction_no": null

11. Advice List (Pending for Remark) API

URL: https://portal.dodeliver.com.pk/ api/advices

METHOD -> GET

QUERY PARAMETERS

Input Description
api_key API Key to be provided individually

RESULT

"status": true,

"advices": {

"current_page": 1,

"data": [

"id": 11502,

"status_id": 10,

"created_at": "2022-11-25T13:34:24.000000Z",

"status": {
 "id": 10,

"name": "Halt - Advice sent"

},

"advices": {

"id": 18,

"order_id": 11502,

"cn": "10011089",

"amount": "133",

"vendor_order_id": "referance ID 444",

"approval": null,

"approval_date": "2022-11-26T00:00:00.000000Z",

"requested_status": "Return Confirmed",

"requested_status_date": "2022-12-24T00:00:00.000000Z",

"remain_time": "2022-12-25T00:00:00.000000Z",

"customer_phone_no": "03875665662",

"rider_remarks": "RFD Updated",

"customer_name": "new Name t",

"total_attempts": 1,

"vendor_remarks": null,

"created_at": "2022-11-26T11:11:03.000000Z",

"updated_at": "2022-12-24T10:46:27.000000Z"

],

"first_page_url": "https://portal.dodeliver.com.pk/api/advice/fetch/list?page=1",

"from": 1,

"last_page": 1,
 "last_page_url": "https://portal.dodeliver.com.pk/api/advice/fetch/list?page=1",

"links": [
{

"url": null,

"label": "« Previous",

"active": false

},

"url": "https://portal.dodeliver.com.pk/api/advice/fetch/list?page=1",

"label": "1",

"active": true

},

"url": null,

"label": "Next »",

"active": false

],

"next_page_url": null,

"path": "https://portal.dodeliver.com.pk/api/advice/fetch/list",

"per_page": 20,

"prev_page_url": null,

"to": 1,

"total": 1

}
12. Advice List (Remark Submitted but not Approved) API

URL: https://portal.dodeliver.com.pk/ api/advices/pending

METHOD -> GET

QUERY PARAMETERS

Input Description
api_key API Key to be provided individually

RESULT

"status": true,

"advices": {

"current_page": 1,

"data": [],

"first_page_url": "https://portal.dodeliver.com.pk/api/advice/fetch/list/pending?page=1",

"from": null,

"last_page": 1,

"last_page_url": "https://portal.dodeliver.com.pk/api/advice/fetch/list/pending?page=1",

"links": [

"url": null,

"label": "« Previous",

"active": false

},

"url": "https://portal.dodeliver.com.pk/api/advice/fetch/list/pending?page=1",

"label": "1",
 "active": true

},

"url": null,

"label": "Next »",

"active": false
}

],

"next_page_url": null,

"path": "https://portal.dodeliver.com.pk/api/advice/fetch/list/pending",

"per_page": 20,

"prev_page_url": null,

"to": null,

"total": 0

13. Advice List (Remark Submitted and Approved) API

URL: https://portal.dodeliver.com.pk/ api/advices/approved

METHOD -> GET

QUERY PARAMETERS

Input Description
api_key API Key to be provided individually
RESULT

"status": true,

"advices": {

"current_page": 1,

"data": [

"id": 11500,
"status_id": 11,

"created_at": "2022-11-25T13:32:18.000000Z",

"status": {

"id": 11,

"name": "Delivered"

},

"advices": {

"id": 19,

"order_id": 11500,

"cn": "10011087",

"amount": "133",

"vendor_order_id": "referance ID 444",

"approval": "Approved",

"approval_date": "2022-11-26T00:00:00.000000Z",

"requested_status": "Return Confirmed",

"requested_status_date": "2022-11-26T00:00:00.000000Z",

"remain_time": "2022-11-27T00:00:00.000000Z",

"customer_phone_no": "03875665662",

"rider_remarks": "RFD",

"customer_name": "new Name t",

 "total_attempts": 1,

"vendor_remarks": "Return",

"created_at": "2022-11-26T11:11:34.000000Z",

"updated_at": "2022-11-26T11:17:18.000000Z"

],

"first_page_url": "https://portal.dodeliver.com.pk/api/advice/fetch/list/approved?page=1",

"from": 1,
"last_page": 1,

"last_page_url": "https://portal.dodeliver.com.pk/api/advice/fetch/list/approved?page=1",

"links": [

"url": null,

"label": "« Previous",

"active": false

},

"url": "https://portal.dodeliver.com.pk/api/advice/fetch/list/approved?page=1",

"label": "1",

"active": true

},

"url": null,

"label": "Next »",

"active": false

],
 "next_page_url": null,

"path": "https://portal.dodeliver.com.pk/api/advice/fetch/list/approved",

"per_page": 20,

"prev_page_url": null,

"to": 1,

"total": 1

14. Add Remark API

URL: https://portal.dodeliver.com.pk/api/advices/[Advice-ID]/remark

METHOD -> POST

ROUTE PARAMETERS

Input Description
Advice-ID ID of Advice, in which you want to add remark

QUERY PARAMETERS

Input Description
api_key API Key to be provided individually

BODY PARAMETERS

Input Description
client_remark Remark Or Message you want to add in advices
client_request_status Request for Reattempt or Return Confirmed

RESULT

{
 "status": true,

"message": "Remark Added"

15. City By Services

URL: https://portal.dodeliver.com.pk/api/services/cities

METHOD -> GET

QUERY PARAMETERS

Input Description

api_key API Key to be provided individually

search filter cities

i.e islam key wil filterout DAR-UL-ISLAM
CO, ISLAMKOT, ISLAMABAD, etc.

RESULT

"status": true,

"message": "1 citie(s) has been found",

"cities": [

"id": 932,

"name": "KARACHI",

"value": "karachi"

}
16. AWB Print

URL: https://portal.dodeliver.com.pk/api/awb-print

METHOD -> POST

QUERY PARAMETERS

Input Description

api_key API Key to be provided individually

BODY PARAMETERS

Input Description

tracking_ids array of order ids i.e.

[1111111,2222222]

RESULT

AWB Pdf File