Get Pickup Requests

Overview

Service To get the list of pickup requests based on customer code and from - to date
Service Unique Name GetPickupRequests
Request Method GET

Introduction

To get the list of pickup requests based on customer code and from - to date

Request Body

These are params:

  • SecureKey: secure key of the organization [Required]
  • customerCode [Required]
  • fromDate [Required]
  • toDate [Required]

Request Parameters

Parameter Data Type Compulsory/Optional Description
SecureKey Compulsory Unique key for accessing the API
customerCode Compulsory Customer code available in erp
fromDate Compulsory Yyyy-mm-dd format
toDate Compulsory Yyyy-mm-dd format

Response

ON SUCCESS
{
"message": "Pickup Requests",
"messageType": "Success",
"pickupRequestDetails": [
{
"consignor": {
"customerAddress": "KAIN building, 3rd street,",
"customerName": "Master"
},
"currentStatus": "ASSIGNED",
"mobile": {
"user": {
"username": "sunnysingh"
}
},
"number": "PRS1617",
"operatingUnit": {
"code": "JOBERG",
"name": "JOHANNESBURG"
},
"pickupAddress": "wrong",
"pickupDate": "2022-07-06T00:00:00",
"remarks": null,
"timeFrom": "1970-01-01T10:00:00",
"timeTo": "1970-01-01T10:00:00"
}, {
"consignor": {
"customerAddress": "KAIN building, 3rd street,",
"customerName": "Master"
},
"currentStatus": "AVAILABLE",
"mobile": null,
"number": "PRS1620",
"operatingUnit": {
"code": "JOBERG",
"name": "JOHANNESBURG"
},
"pickupAddress": "EASTERNCAPE,SA",
"pickupDate": "2022-07-06T00:00:00",
"remarks": null,
"timeFrom": "1970-01-01T10:00:00",
"timeTo": "1970-01-01T10:00:00"
}
]
}

please wait...