Vuxx API (2021.10.01)
Download OpenAPI specification:Download
APIs e webhooks da plataforma Vuxx.
Atualização de rota — motorista e veículo Webhook
Envio das informações do motorista e do veículo que irão executar uma rota.
Neste webhook é enviada uma única ocorrência, referente a uma única rota. Por padrão as ocorrências são enviadas assim que o fato é registrado no sistema.
O cliente deverá usar um status de resposta HTTP apropriado para sinalizar o recebimento (ou não) do lote, e isso influenciará a política de retentativas.
Request Body schema: application/json
| id | string Identificador único para este envio. Pode ser usado para deduplicar requisições. |
object (EventoPosAlocacao) |
Responses
Request samples
- Payload
{- "id": "89e8f7b7-43f4-4a5e-a32a-054f75dd1f80",
- "evento": {
- "dataHora": "2021-10-26T15:04:33-03:00",
- "rota": {
- "id": "101325",
- "idExterno": "string"
}, - "motorista": {
- "nome": "Augusto Martins de Souza",
- "cpf": "33941761815"
}, - "veiculo": {
- "placa": "ZBF3U11"
}
}
}Envio de ocorrências de transporte Webhook
Quando algum evento de transporte ocorre, a plataforma da Vuxx pode ser configurada para enviar as informações do evento para uma URL definida pelo cliente.
Neste webhook é enviada uma coleção ou lote de ocorrências. Por padrão as ocorrências são enviadas assim que o fato é registrado no sistema. Alguns eventos ocorrem naturalmente em lote — por exemplo, quando um veículo é carregado com 5 mercadorias, uma série de 5 ocorrências é gerada para todas essas mercadorias.
O cliente deverá usar um status de resposta HTTP apropriado para sinalizar o recebimento (ou não) do lote, e isso influenciará a política de retentativas.
Request Body schema: application/json
| id required | string Identificador único para este lote de ocorrências. Pode ser usado para deduplicar requisições. |
required | Array of objects (Ocorrencia) Cada elemento representa uma ocorrência de uma única remessa ou mercadoria. |
Responses
Request samples
- Payload
{- "id": "89e8f7b7-43f4-4a5e-a32a-054f75dd1f80",
- "ocorrencias": [
- {
- "id": "9614a09b-9fb5-4476-bb4f-4f4ada2e9156",
- "remessa": {
- "codigo": "0135569",
}, - "dataHora": "2021-10-26T15:04:33-03:00",
- "localizacao": {
- "latitude": -23.7,
- "longitude": -46.6
}, - "descricao": "Entregue ao destinatário",
- "codigoOcoren": "01"
}
]
}Solicitar veículo (entregas)
Request Body schema: application/json
| vehicleType required | string (VehicleType) Enum: "MOTO" "FIORINO" "VAN" "HR" "IVECO" "3/4" "TOCO" "TRUCK" Tipo de veículo a solicitar, dentro de uma das categorias a seguir:
| |||||||||||||||||||||||||||
| scheduledFor required | string <date-time> (ScheduledFor) Data agendada para o carregamento, no formato | |||||||||||||||||||||||||||
| notes | string or null (Notes) Observações sobre a rota. | |||||||||||||||||||||||||||
| driverAssistantsCount | integer (DriverAssistantsCount) [ 0 .. 3 ] Número de ajudantes solicitados, entre 0 e 3. | |||||||||||||||||||||||||||
| externalId | string or null (ExternalOrderId) [ 1 .. 100 ] characters Identificador desta rota/viagem, para uso livre do cliente. Idealmente esse identificador é único, mas não aplicamos isso como restrição. Geralmente este campo é preenchido com um número de romaneio, ordem de coleta ou ordem de carga. Não havendo nenhum valor de interesse, esse campo deve ser omitido ou preenchido com | |||||||||||||||||||||||||||
| totalWeight | number or null (TotalWeight) >= 0 Peso total estimado para a carga, em quilogramas (kg). Caso não saiba, omita o campo ou preencha com Exemplos:
| |||||||||||||||||||||||||||
required | object (Warehouse) | |||||||||||||||||||||||||||
required | Array of objects (Merchandises) |
Responses
Request samples
- Payload
{- "vehicleType": "MOTO",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "notes": "Necessário levar bota e EPI.",
- "driverAssistantsCount": 1,
- "externalId": "string",
- "totalWeight": 0,
- "warehouse": {
- "address": {
- "postalCode": "01541000",
- "number": "461",
- "complement": "ap. 43",
- "latitude": -23.455855,
- "longitude": -46.6168014,
- "thoroughfare": "Avenida Nove de Julho",
- "neighborhood": "Bela Vista",
- "city": "Curitiba",
- "state": "PR"
}, - "shipper": {
- "name": "Carolina Sanchez - galpão 12",
- "nationalDocumentNumber": "string",
- "phoneNumber": "1139591112"
}, - "timeWindow": {
- "start": "06:00",
- "end": "21:00"
}
}, - "merchandises": [
- {
- "trackingCode": "J153908",
- "accessKey": "32191105570714000825550010059146621133082968",
- "notes": "prédio sem número - Edifício Carmen",
- "totalWeight": 513.09,
- "packagesAmount": 3,
- "address": {
- "postalCode": "01541000",
- "number": "461",
- "complement": "ap. 43",
- "latitude": -23.455855,
- "longitude": -46.6168014,
- "thoroughfare": "Avenida Nove de Julho",
- "neighborhood": "Bela Vista",
- "city": "Curitiba",
- "state": "PR"
}, - "recipient": {
- "name": "Marcela Araujo",
- "nationalDocumentNumber": "28135322715",
- "phoneNumber": "31985312204"
}, - "timeWindow": { }
}
]
}Response samples
- 200
- 422
- 500
{- "orderId": 0,
- "protocol": "string",
- "quote": {
- "distanceInKm": "102.29",
- "price": "string",
- "freightPrice": "187.77",
- "advanceBookingDiscount": "24.37",
- "driverAssistantsPrice": "0.00",
- "tollPrice": "36.60",
- "totalPrice": "200.00"
}
}Cotar veículo (entregas)
Request Body schema: application/json
| vehicleType required | string (VehicleType) Enum: "MOTO" "FIORINO" "VAN" "HR" "IVECO" "3/4" "TOCO" "TRUCK" Tipo de veículo a solicitar, dentro de uma das categorias a seguir:
| |||||||||||||||||||||||||||
| scheduledFor required | string <date-time> (ScheduledFor) Data agendada para o carregamento, no formato | |||||||||||||||||||||||||||
| notes | string or null (Notes) Observações sobre a rota. | |||||||||||||||||||||||||||
| driverAssistantsCount | integer (DriverAssistantsCount) [ 0 .. 3 ] Número de ajudantes solicitados, entre 0 e 3. | |||||||||||||||||||||||||||
| totalWeight | number or null (TotalWeight) >= 0 Peso total estimado para a carga, em quilogramas (kg). Caso não saiba, omita o campo ou preencha com Exemplos:
| |||||||||||||||||||||||||||
required | object (Warehouse) | |||||||||||||||||||||||||||
required | Array of objects (Merchandises) |
Responses
Request samples
- Payload
{- "vehicleType": "MOTO",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "notes": "Necessário levar bota e EPI.",
- "driverAssistantsCount": 1,
- "totalWeight": 0,
- "warehouse": {
- "address": {
- "postalCode": "01541000",
- "number": "461",
- "complement": "ap. 43",
- "latitude": -23.455855,
- "longitude": -46.6168014,
- "thoroughfare": "Avenida Nove de Julho",
- "neighborhood": "Bela Vista",
- "city": "Curitiba",
- "state": "PR"
}, - "shipper": {
- "name": "Carolina Sanchez - galpão 12",
- "nationalDocumentNumber": "string",
- "phoneNumber": "1139591112"
}, - "timeWindow": {
- "start": "06:00",
- "end": "21:00"
}
}, - "merchandises": [
- {
- "trackingCode": "J153908",
- "accessKey": "32191105570714000825550010059146621133082968",
- "notes": "prédio sem número - Edifício Carmen",
- "totalWeight": 513.09,
- "packagesAmount": 3,
- "address": {
- "postalCode": "01541000",
- "number": "461",
- "complement": "ap. 43",
- "latitude": -23.455855,
- "longitude": -46.6168014,
- "thoroughfare": "Avenida Nove de Julho",
- "neighborhood": "Bela Vista",
- "city": "Curitiba",
- "state": "PR"
}, - "recipient": {
- "name": "Marcela Araujo",
- "nationalDocumentNumber": "28135322715",
- "phoneNumber": "31985312204"
}, - "timeWindow": { }
}
]
}Response samples
- 200
- 422
- 500
{- "distanceInKm": "102.29",
- "price": "string",
- "freightPrice": "187.77",
- "advanceBookingDiscount": "24.37",
- "driverAssistantsPrice": "0.00",
- "tollPrice": "36.60",
- "totalPrice": "200.00"
}