Assign driver

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

Assign a driver to a delivery or route.

Assign a driver to a delivery or route.

POSThttps://api.shippify.co/v1/routes/{id}/assign

Authorization

Basic_Auth

Path parameters

id*string

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

Body

application/json

Description goes here

courierId*integer

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

Example: 1234

vehicleIdinteger

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

Example: 2344

vehicleReferenceIdstring

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

Example: 2344

driverobject

Driver's information. Only sent if it's necessary to create the driver within the system.

vehicleobject

Driver's vehicle information. Only sent if it's necessary to create the driver within the system.

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/routes/{id}/assign', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "courierId": 1234
    }),
});
const data = await response.json();

Response

200401

{
  "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": "LUIS ALBERTO",
        "lastName": "PILALUISA CONDOR",
        "dni": "1721547592",
        "mobile": "0990670384"
    },
    "vehicle": {
        "capacity": 1,
        "model": "Truck",
        "brand": "SINOTRUCK",
        "licensePlate": "TAA6662",
        "referenceId": "UE1118"
    }
}