MOVER BUSINESS API
  1. Orders
MOVER BUSINESS API
  • Orders
    • Estimate / Coverage
      POST
    • Book Vehicle
      POST
    • Invoice
      GET
    • Status
      GET
    • Cancel
      POST
    • Partner Location
      GET
    • Pool
      POST
  • Utility
    • Segregate Delivery Locations
      POST
  • Webhooks
  1. Orders

Cancel

POST
https://api.boxnmove.comhttps://api.boxnmove.com/business/cancel-order
Cancel an order before a delivery partner has picked up the package.
Post Pick up the order is not cancellable.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.boxnmove.com/business/cancel-order' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "OrderId": "XYZZZZZ",
    "CancelReason": "Package is not ready."
}'
Response Response Example
200 - Success
{
    "order": {
        "OrderId": "XYZZZZZ",
        "StatusId": 8,
        "DriverId": 88727,
        "RiderId": 167267,
        "PickUpLatitude": 28.621888080271027,
        "DropOffLatitude": 28.570856965608034,
        "DropOffLongitude": 77.31377564370632,
        "PickUpLongitude": 77.38637801259756,
        "PickUpAddress": "81, Block E, Sector 63, Noida, Hazratpur Wajidpur, Uttar Pradesh 201301, India",
        "DropOffAddress": "06, FC8, Film City, Sector 16A, Noida, Uttar Pradesh 201301, India",
        "NeedHelper": 0,
        "DriverHelperFees": 0,
        "CouponCode": null,
        "Amount": 160,
        "TotalDistance": 12129,
        "PickupOtp": "6992",
        "DropOffOtp": "7055",
        "VehicleId": 5,
        "CreatedAt": 1716392574,
        "UpdatedAt": 1716395389,
        "DriverDeviceId": "88727",
        "VehicleNumberPlate": "DLxxxxx577",
        "VehicleName": "Bike",
        "RiderName": "Jhon Doe",
        "DriverName": "Mark Finn",
        "DriverMobile": "9999999999",
        "RiderMobile": "9999999999",
        "PickUpTripId": "xxxxxxxx",
        "DropOffTripId": "xxxxxxx",
        "GoodsTypeId": 1,
        "PickUpContactNo": "xxxxxxx",
        "PickUpContactName": "xxxxxxx",
        "RecieverContactNo": "99999999999",
        "RecieverContactName": "xxxxxx",
        "PickupTrackingUrl": "https://api.boxnmove.com/track/order/XXXXXXX",
        "DropOffTrackingUrl": "https://api.boxnmove.com/track/order/XXXXXXX",
        "EstimatedJourneyTime": 1350,
        "ActualJourneyTime": 2164,
        "ActualAmount": 160,
        "PaymentMode": 2,
        "ActualJourneyDistance": 11662,
        "ReceivedPaymentMode": 2,
        "DriverTip": 0,
        "PaymentStatus": 1,
        "AmountReceived": 160,
        "CancelReason": "Package is not ready.",
        "CancelledBy": 1232,
        "DiscountAmount": 0,
        "MoverCommission": 0,
        "DriverReward": 0,
        "DropOffTripStartAt": "2024-05-22T15:53:30.716769",
        "ZoneId": 2,
        "PricingId": 0,
        "IsOutStation": 0,
        "DestinationPolyline": "wmumDsoiwME`BvDP~H\\jCH~FXhG\\vI^vCRbCDfI^fJd@bIZN@?LSfGk@rQxGP~OVjFLjMTnDFAgLp@@BvGA`DM|KGnFOpHO|JIlD[vHAx@Dv@ZxBl@jBdAjB|D~FxAxBpC~D~A~B|BlDr@bAlC~DnGdJvE~GhAdBvDpFxAzBvClEb@x@`HbKbCnDbGdJrBzCnDdFd@t@hBbCfDlFfCvD`GtI`AxAV\\lB|CfD|Eh@t@fAzATb@nArBh@z@vEfHdG`Jv@lAnC`ElFbId@p@zLnQx@rArAlB|@lAlBpC`DvEn@|@tHxJfFtGfCxDx@xAN^FTRdAlAnIZpDXvARrATjCp@hIBVCFIHKBO?IGKOg@oFs@F_Df@c@T{@n@mAx@cEjCgL~HeAn@",
        "PickupPolyline": "_jvmDoigwMxAFjKd@@O?I@QNoBDmATgIRqHPoDFSVe@lCJFCFUPoDgCK}FU?WLmEPkGZwK~Lf@HuCzFV",
        "DestinationArrivalBy": "2024-05-22T16:15:10.680386",
        "PickupArrivalBy": "2024-05-22T15:50:56.792024",
        "NoOfStops": 0,
        "OrderPlacedAt": "2024-05-22T15:42:54.023166",
        "OrderCompletedAt": "2024-05-22T16:29:49.020173",
        "ArrivedAtPickupAt": "2024-05-22T15:51:07",
        "ExitFromPickupAt": "2024-05-22T15:53:30.716772",
        "FreeLoadingSeconds": 1500,
        "TripStartedAt": "2024-05-22T15:53:30.716772",
        "TripEndedAt": "2024-05-22T16:29:35.288871",
        "ArrivedAtDropAt": "2024-05-22T16:29:14",
        "ExitFromDropAt": null,
        "DriverPickupLat": null,
        "DriverPickupLng": null,
        "DriverDropLat": null,
        "DriverDropLng": null,
        "FareRecalculated": 0,
        "MinsSpentAtPickup": 2,
        "MinsSpentAtDrop": 0,
        "TotalMinsSpent": 2,
        "ChargeableWaitMins": 0,
        "ChargePerWaitMin": 2,
        "ExtraKmGone": -12,
        "ChargePerExtraKm": 0,
        "WaitingCharge": 0,
        "ExtraKmCharge": 0,
        "CashbackGiven": 0,
        "CashbackAmount": 0,
        "WalletPay": 0,
        "PriceAgreed": 0,
        "IsInsured": false,
        "GoodsValue": 0,
        "PremiumAmount": 0
    },
    "tolls": [],
    "stops": []
}

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Body Params application/json
OrderId
string 
required
The OrderId recieved in the response of Book Vehicle endpoint.
CancelReason
string 
required
Describe the reason for cancellation.
eg. Package not ready.
Examples

Responses

🟢200Success
application/json
Body
order
object 
required
OrderId
string 
required
StatusId
integer 
required
DriverId
integer 
required
RiderId
integer 
required
PickUpLatitude
number 
required
DropOffLatitude
number 
required
DropOffLongitude
number 
required
PickUpLongitude
number 
required
PickUpAddress
string 
required
DropOffAddress
string 
required
NeedHelper
integer 
required
DriverHelperFees
integer 
required
CouponCode
null 
required
Amount
integer 
required
TotalDistance
integer 
required
PickupOtp
string 
required
DropOffOtp
string 
required
VehicleId
integer 
required
CreatedAt
integer 
required
UpdatedAt
integer 
required
DriverDeviceId
string 
required
VehicleNumberPlate
string 
required
VehicleName
string 
required
RiderName
string 
required
DriverName
string 
required
DriverMobile
string 
required
RiderMobile
string 
required
PickUpTripId
string 
required
DropOffTripId
string 
required
GoodsTypeId
integer 
required
PickUpContactNo
string 
required
PickUpContactName
string 
required
RecieverContactNo
string 
required
RecieverContactName
string 
required
PickupTrackingUrl
string 
required
DropOffTrackingUrl
string 
required
EstimatedJourneyTime
integer 
required
ActualJourneyTime
integer 
required
ActualAmount
integer 
required
PaymentMode
integer 
required
ActualJourneyDistance
integer 
required
ReceivedPaymentMode
integer 
required
DriverTip
integer 
required
PaymentStatus
integer 
required
AmountReceived
integer 
required
CancelReason
null 
required
CancelledBy
integer 
required
DiscountAmount
integer 
required
MoverCommission
integer 
required
DriverReward
integer 
required
DropOffTripStartAt
string 
required
ZoneId
integer 
required
PricingId
integer 
required
IsOutStation
integer 
required
DestinationPolyline
string 
required
PickupPolyline
string 
required
DestinationArrivalBy
string 
required
PickupArrivalBy
string 
required
NoOfStops
integer 
required
OrderPlacedAt
string 
required
OrderCompletedAt
string 
required
ArrivedAtPickupAt
string 
required
ExitFromPickupAt
string 
required
FreeLoadingSeconds
integer 
required
TripStartedAt
string 
required
TripEndedAt
string 
required
ArrivedAtDropAt
string 
required
ExitFromDropAt
null 
required
DriverPickupLat
null 
required
DriverPickupLng
null 
required
DriverDropLat
null 
required
DriverDropLng
null 
required
FareRecalculated
integer 
required
MinsSpentAtPickup
integer 
required
MinsSpentAtDrop
integer 
required
TotalMinsSpent
integer 
required
ChargeableWaitMins
integer 
required
ChargePerWaitMin
integer 
required
ExtraKmGone
integer 
required
ChargePerExtraKm
integer 
required
WaitingCharge
integer 
required
ExtraKmCharge
integer 
required
CashbackGiven
integer 
required
CashbackAmount
integer 
required
WalletPay
integer 
required
PriceAgreed
integer 
required
IsInsured
boolean 
required
GoodsValue
integer 
required
PremiumAmount
integer 
required
tolls
array[string]
required
stops
array[string]
required
🟠400Bad Request
Previous
Status
Next
Partner Location
Built with