Couriers

Create a courier

Register a new courier for the organization's internal fleet with contact and vehicle details.

post/v1/courier

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Request body

externalidentifierstring nullable

The external identifier of the courier.

firstnamestring required

The first name of the courier.

lastnamestring required

The last name of the courier.

phonenumberstring required

The phone number of the courier.

dateofbirthstring date nullable

The date of birth of the courier.

workrelationship'EMPLOYEE' | 'CONTRACTOR'
driverslicensestring nullable

The driver's license number of the courier.

vehicleidsstring[] nullable

The vehicles of the courier.

Example request

{
  "externalidentifier": "courier_ext_1",
  "firstname": "John",
  "lastname": "Doe",
  "phonenumber": "+1234567890",
  "dateofbirth": "1990-01-15",
  "driverslicense": "DL123456",
  "vehicleids": [
    "veh_1",
    "veh_2"
  ]
}

Response

OK

idstring required

The ID of the courier.

externalidentifierstring required

The external identifier of the courier.

firstnamestring required

The first name of the courier.

lastnamestring required

The last name of the courier.

phonenumberstring required

The phone number of the courier.

createdatstring required

The creation timestamp of the courier.

firstversioncontractidsstring[] required

The first version contract IDs of the courier.

dateofbirthstring date nullable

The date of birth of the courier.

workrelationship'EMPLOYEE' | 'CONTRACTOR'
driverslicensestring nullable

The driver's license number of the courier.

vehicleidsstring[] required

The vehicles of the courier.

Changes

No recorded changes to this operation across all 1 revision of this API.