Cancel Shipments


Description

End point will allow the user to cancel the shipment. Note: Shipment can be deleted before the driver starts the trip.


Resource

/pbb/adm/cancelshipment


Name Type Description
shipmentId * long Reference id for Shipment

Request

{
    "shipmentId":341
}
{
    "responseCode":1000,
    "errors":null,
    "cancelled":{true/false},
    "reason":"Trip already started"
}

Error

{
    "responseCode": "1001",
    "errors": [
        {
            "code": "TI.0.3.53",
            "data": "Shipment you are trying to cancel is already deleted or may be an invalid ID"
        }
      ],
    "responseMessage": null,
    "isValid": null,
    "cancelled": false,
    "reason": null
}