Returns
Response Object object
Response object child attributes
id
Integer
Unique identifier for the carrier.
personalId
String
Internal personal ID associated with the carrier.
name
String
Full name of the carrier, e.g. "Driver Abc".
codeName
String
Optional code name assigned to the carrier. Can be empty.
phoneNumber
String
Carrier's contact phone number in E.164 format, e.g. "+44555777000".
companyId
Integer
Identifier for the company the carrier belongs to.
areaId
Integer
Identifier for the operational area assigned to the carrier.
isOnShift
Boolean
true
if the carrier is currently on shift; otherwisefalse
.
String
Email address for the carrier, e.g. "[email protected]".
carrierPhoto
String
URL to the carrier’s profile photo.
isActive
Boolean
true
if the carrier is active and allowed to receive orders.
carrrierLocationLat
Float
Last known latitude of the carrier's location.
carrrierLocationLng
Float
Last known longitude of the carrier's location.