Retrieve Shipments


Description

End point will list the shipment created by the user.


Resource

/pbb/adm/retrieveshipments


Name Type Description
carrierId * long ID which will be given at the time of registration
date * String ("yyyy-MM-dd") Select Date Range
toDate * String ("yyyy-MM-dd") Select Date Range

Request

{
    "carrierId":735,
    "date":"2015-10-11",
    "toDate":"2015-10-15"
}
{
    "responseCode":"1000",
    "errors":null,
    "completed":[
        {
            "shipment":
                {
                    "shipmentId":345,
                    "address":[
                        {
                            "addressId":112,
                            "name":"Rahul",
                            "phone":"8789304400",
                            "address":"Jogeshwari East, Mumbai, Maharashtra 400093",
                            "sublocality":"",
                            "locality":"Jogeshwari",
                            "city":"Mumbai",
                            "lat":12.95173,
                            "lng":80.1402,
                            "amount":0.0,
                            "loads":null,
                            "gaddress":"Jogeshwari East, Mumbai, Maharashtra 400093"
                        }
                      ],
                    "dest":[
                        {
                            "addressId":115,
                            "name":"John Bricks",
                            "phone":"9823921234",
                            "address":"Powai Flyover, Mumbai, Maharashtra 400076",
                            "sublocality":"",
                            "locality":"Powai",
                            "city":"Mumbai",
                            "lat":12.95173,
                            "lng":80.1402,
                            "amount":0.0,
                            "loads":null,
                            "gaddress":"Powai Flyover, IIT Area, Mumbai, Maharashtra 400076"
                        }
                      ],
                    "user":null,
                    "cod":200.0,
                    "orderNumber":"CR_456",
                    "orderId":"25",
                    "express":0,
                    "slotted":1,
                    "deliveryDate":"2015-09-16 00:00:00",
                    "uid":"af731b8117154ec38e1eda0b98072336",
                    "clientId":1
                },
            "driver":
                {
                    "userId":128,
                    "firstName":"John",
                    "lastName":"Blake",
                    "userType":3,
                    "email":"john@parsel.in",
                    "phone":"2938495039",
                    "online":1,
                    "lat":12.891528,
                    "lng":80.084458
                },
            "status":null
        }
      ],
    "turnedAway":[
        {
            "shipment":
                {
                    "shipmentId":351,
                    "address":[
                        {
                            "addressId":116,
                            "name":"Sumit",
                            "phone":"9699777307",
                            "address":"Malvani, Malad West, Mumbai, Maharashtra 400064",
                            "sublocality":"",
                            "locality":"Malvani",
                            "city":"Mumbai",
                            "lat":13.082456,
                            "lng":80.170303,
                            "amount":600.0,
                            "loads":null,
                            "gaddress":"Malvani, Malad West, Mumbai, Maharashtra 400064"
                        }
                      ],
                    "dest":[
                        {
                            "addressId":115,
                            "name":"John Bricks",
                            "phone":"9823921234",
                            "address":"Powai Flyover, Mumbai, Maharashtra 400076",
                            "sublocality":"",
                            "locality":"Powai",
                            "city":"Mumbai",
                            "lat":12.95173,
                            "lng":80.1402,
                            "amount":0.0,
                            "loads":null,
                            "gaddress":"Powai Flyover, IIT Area, Mumbai, Maharashtra 400076"
                        }
                      ],
                    "user":null,
                    "cod":200.0,
                    "orderNumber":"CR_459",
                    "orderId":"28",
                    "express":0,
                    "slotted":1,
                    "deliveryDate":"2015-09-16 00:00:00",
                    "uid":"rs731b8117153ec38e1eda0b98072193",
                    "clientId":1
                },
            "driver":
                {
                    "userId":131,
                    "firstName":"Adam",
                    "lastName":"Williams",
                    "userType":3,
                    "email":"adam@parsel.in",
                    "phone":"9384950392",
                    "online":1,
                    "lat":12.891528,
                    "lng":80.084458
                },
            "status":null
        }
      ],
  "pending":[
      {
          "shipment":
              {
                  "shipmentId":353,
                  "address":[
                      {
                          "addressId":117,
                          "name":"Suresh",
                          "phone":"9699777307",
                          "address":"Mulund West, Mumbai, Maharashtra 400080",
                          "sublocality":"",
                          "locality":"Mulund",
                          "city":"Mumbai",
                          "lat":19.1736966,
                          "lng":72.9280474,
                          "amount":0.0,
                          "loads":null,
                          "gaddress":"Mulund West, Mumbai, Maharashtra 400080"
                      }
                    ],
                  "dest":[
                      {
                          "addressId":115,
                          "name":"John Bricks",
                          "phone":"9823921234",
                          "address":"Powai Flyover, Mumbai, Maharashtra 400076",
                          "sublocality":"",
                          "locality":"Powai",
                          "city":"Mumbai",
                          "lat":12.95173,
                          "lng":80.1402,
                          "amount":0.0,
                          "loads":null,
                          "gaddress":"Powai Flyover, IIT Area, Mumbai, Maharashtra 400076"
                      }
                    ],
                  "user":null,
                  "cod":200.0,
                  "orderNumber":"CR_462",
                  "orderId":"33",
                  "express":0,
                  "slotted":1,
                  "deliveryDate":"2015-12-16 00:00:00",
                  "uid":"fj731b8117154ec38e1eda0b98072341",
                  "clientId":3
              },
          "driver":
              {
                  "userId":128,
                  "firstName":"John",
                  "lastName":"Blake",
                  "userType":3,
                  "email":"john@parsel.in",
                  "phone":"2938495039",
                  "online":1,
                  "lat":12.891528,
                  "lng":80.084458
              },
          "status":null
      }
    ]
}

Error

{
    "responseCode": "1001",
    "errors": [
        {
            "code": "TI.0.3.13",
            "data": null
        }
      ],
    "responseMessage": null,
    "isValid": null,
    "completed": null,
    "turnedAway": null,
    "pending": null
}