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

Status

GET
https://api.boxnmove.com/business/order-status/{OrderId}
Check Order Status
Check the status of a specific order. By providing the OrderId, you can retrieve detailed information about the order's current status, including various attributes such as driver details, pickup and drop-off locations, journey times, and payment status.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.boxnmove.com/business/order-status/' \
--header 'Authorization: Basic Og=='
Response Response Example
{
  "order": {
    "OrderId": "XYZZZZZ",
    "StatusId": 11,
    "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": null,
    "CancelledBy": 0,
    "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
  },
  "rating": null,
  "tolls": [],
  "stops": [],
  "insurance_policy": null,
  "partner_location": {
    "latitude": 28.58993203,
    "longitude": 77.37682413,
    "location_time": "2024-07-12T08:43:14"
  }
}

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 *****************
Path Params
OrderId
string 
required

Responses

🟢200Success
application/json
Body
order
object 
required
OrderId
string 
required
StatusId
integer 
required
Integer
1 - Accepted/ Finding Delivery Partner
2 - Delivery Partner Assigned
3 - Partner is on the way to pickup location
4 - Partner has reached at pickup location
5 - Delivery started. Partner is on the way to drop
6 - Partner has reached drop location
8 - cancelled
9 - Bill/invoice is getting generated
10 - Waiting for the payment
11 - Order has COMPLETED
DriverId
integer 
required
RiderId
integer 
required
PickUpLatitude
number 
required
DropOffLatitude
number 
required
DropOffLongitude
number 
required
PickUpLongitude
number 
required
PickUpAddress
string 
required
Full Pickup Address
DropOffAddress
string 
required
Full Drop Address
NeedHelper
integer 
required
Whether a Helper is needed for loading or unloading packages on pickup /drop locations.
0 No
1 Yes
DriverHelperFees
integer 
required
Amount/Cost of labour included (if applicable) in delivery order in Indian Rupees (INR).
CouponCode
null 
required
Amount
integer 
required
Amount/Cost of Delivery order in Indian Rupees (INR).
TotalDistance
integer 
required
Estimated distance between pickup and drop locations in meters.
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
in seconds
ActualJourneyTime
integer 
required
In seconds
ActualAmount
integer 
required
The final amount/cost of delivery order in Indian Rupees(INR) in case there was waiting time captured by the system.
PaymentMode
integer 
required
1 Online2 Cash
ActualJourneyDistance
integer 
required
in seconds
ReceivedPaymentMode
integer 
required
1 Online
2 Cash
DriverTip
integer 
required
PaymentStatus
integer 
required
AmountReceived
integer 
required
The amount recieved upon order completion. INR)
CancelReason
null 
required
CancelledBy
integer 
required
DiscountAmount
integer 
required
INR
MoverCommission
integer 
required
MOVER platform comission in indian rupees (if applicable) else 0
DriverReward
integer 
required
INR
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
rating
object  | null 
optional
tolls
array[string] | null 
optional
stops
array[string] | null 
optional
insurance_policy
object 
optional
partner_location
object  | null 
optional
Available only during the trip. Unavailble before partner not assigned or order has been cancelled or completed.
latitude
number  | null 
optional
location_time
string  | null 
optional
longitude
number  | null 
optional
🔴500Server Error
Modified at 2024-07-12 03:05:22
Previous
Invoice
Next
Cancel
Built with