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; otherwise false.

---

email String

Email address for the carrier, e.g. "kalam@shipday.com".

---

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.

Example Response

[
  {
    "id": 108418,
    "personalId": "123",
    "name": "Driver Shammo",
    "codeName": "",
    "phoneNumber": "+44555777000",
    "companyId": 41207,
    "areaId": 41189,
    "isOnShift": false,
    "email": "shammo@shipday.com",
    "carrierPhoto": "https://myurl/ca842047bf324c6eaab5db2b0297d054.png",
    "isActive": true,
    "carrrierLocationLat": 23.7729884,
    "carrrierLocationLng": 90.3595206
  },
  {
    "id": 342163,
    "personalId": "",
    "name": "Test Driver another one",
    "codeName": "",
    "phoneNumber": "+8801973391748",
    "companyId": 41207,
    "areaId": 41189,
    "isOnShift": false,
    "email": "versatileanthem@gmail.com",
    "carrierPhoto": null,
    "isActive": true,
    "carrrierLocationLat": null,
    "carrrierLocationLng": null
  }
]