Atrelar motorista

Com esse endpoint podemos atrelar um motorista ou um veículo à uma entrega.

Designa um motorista à uma entrega da rota.

Designa um motorista à uma entrega da rota.

post

/v1/routes/{id}/assign

Authorizations

Path parameters

idstringrequired

Id de referência da entrega ou rota que vai ser designada à um motorista.

Body

courierIdintegerrequired

Identificador do motorista que vai ser designado uma rota/entrega. Não se envia outra propriedade no payload

Example: 1234

vehicleIdinteger

Identificador do veículo do motorista que vai ser designado uma rota/entrega. Não se envia outra propriedade no payload

Example: 2344

vehicleReferenceIdstring

Referência do veículo do motorista que vai ser designado uma rota/entrega. Não se envia outra propriedade no payload

Example: 2344

driverobject

Informação do motorista. Só se envia no caso de que seja necessário criar um motorista dentro do sistema.

vehicleobject

Informação do veículo do motorista. Só se envaa no caso que seja necessário criar um motorista dentro do sistema.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.shippify.co/v1/routes/{id}/assign' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "courierId": 1234,
    "vehicleId": 2344,
    "vehicleReferenceId": 2344,
    "driver": {
      "firstName": "LUIS ALBERTO",
      "lastName": "PILALUISA CONDOR",
      "dni": "1721547592",
      "mobile": "0990670384"
    },
    "vehicle": {
      "capacity": 1,
      "modo": "Civic",
      "brand": "Honda",
      "licensePlate": "TAA6662",
      "referenceId": "UE1118"
    }
  }'

200

401

200

{
  "code": "OK"
}

Operação bem sucedida.

Casos de uso

Atrelar um motorista à um ID de entrega

{
    "courierId": 396930
}

Atrelar um motorista à um referenceID de entrega

Utilize o referenceid da entrega na url da petição para atrelar um motorista.

Atrelar motorista por id do veículo

{
    "vehicleId": 19365
}

Atrelar motorista por id de referência do veículo

{
    "vehicleReferenceId": 19365
}

Criar e atrelar veículo e motorista à uma tarefa

{
    "driver": {
        "firstName": "LUIS ALBERTO",
        "lastName": "PILALUISA CONDOR",
        "dni": "1721547592",
        "mobile": "0990670384"
    },
    "vehicle": {
        "capacity": 1,
        "model": "EMPRESA DE TRANSPORTE PESADO",
        "brand": "SINOTRUCK",
        "licensePlate": "TAA6662",
        "referenceId": "UE1118"
    }
}