Returns
Response Object object
Response object child attributes
idInteger
Unique identifier for the carrier.
personalIdString
Internal personal ID associated with the carrier.
nameString
Full name of the carrier, e.g. "Driver Abc".
codeNameString
Optional code name assigned to the carrier. Can be empty.
phoneNumberString
Carrier's contact phone number in E.164 format, e.g. "+44555777000".
companyIdInteger
Identifier for the company the carrier belongs to.
areaIdInteger
Identifier for the operational area assigned to the carrier.
isOnShiftBoolean
trueif the carrier is currently on shift; otherwisefalse.
String
Email address for the carrier, e.g. "[email protected]".
carrierPhotoString
URL to the carrier’s profile photo.
isActiveBoolean
trueif the carrier is active and allowed to receive orders.
carrrierLocationLatFloat
Last known latitude of the carrier's location.
carrrierLocationLngFloat
Last known longitude of the carrier's location.
