Assign driver

With this endpoint, you can assign a driver or vehicle to a delivery.

Assign a driver to a delivery or route.

post

Assign a driver to a delivery or route.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Parámetros de ruta

idstringRequerido

Identifier or reference Id of the delivery or route to which a driver will be assigned

Cuerpo

application/json

courierIdintegerRequerido

Driver identifier to whom the delivery/route will be assigned. No other property is sent in the payload

Example: 1234

vehicleIdintegerOpcional

Driver's vehicle identifier to which the delivery/route will be assigned. No other property is sent in the payload

Example: 2344

vehicleReferenceIdstringOpcional

Driver's vehicle reference to which the delivery/route will be assigned. No other property is sent in the payload

Example: 2344

Respuestas

200

Successful operation

application/json

401

Unauthorized

application/json

post

/v1/routes/{id}/assign

HTTPcURLJavaScriptPython

POST /v1/routes/{id}/assign HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "courierId": 1234,
  "vehicleId": 2344,
  "vehicleReferenceId": 2344,
  "driver": {
    "firstName": "Juan",
    "lastName": "Perez",
    "dni": "9999999999",
    "mobile": "9999999999"
  },
  "vehicle": {
    "capacity": 1,
    "model": "Corolla",
    "brand": "Toyota",
    "licensePlate": "ABC123",
    "referenceId": "A12345"
  }
}

{
  "code": "OK"
}

Casos de uso

Assign driver to delivery ID

{
    "courierId": 396930
}

Assign driver to delivery reference ID

You can use the delivery reference ID in the URL of the request to assign a driver.

Assign driver by vehicle ID

{
    "vehicleId": 19365
}

Assign driver by vehicle reference ID

{
    "vehicleReferenceId": 19365
}

Create and assign a vehicle and driver to a task

{
    "driver": {
        "firstName": "Juan",
        "lastName": "Perez",
        "dni": "0999999999",
        "mobile": "0999999999"
    },
    "vehicle": {
        "capacity": 1,
        "model": "Toyota",
        "brand": "Corolla",
        "licensePlate": "T99999999",
        "referenceId": "A99999999"
    }
}