Encomendas para dentro. Rotas para fora.
Envie trabalhos a partir do sistema que já usa e receba uma rota sequenciada com os seus próprios identificadores intactos. Três endpoints, sem SDK.
Três chamadas, e a superfície acaba aqui
| Verbo | Caminho | Finalidade |
|---|---|---|
| POST | /v1/integration-token | Trocar credenciais de cliente por um token bearer, válido uma hora |
| POST | /v1/integration-import | Importar um trabalho com as suas paragens, geocodificar as moradas, otimizar a rota e atribuir o condutor — num só pedido |
| GET | /v1/integration-jobs | Estado do trabalho e das paragens: contagens de progresso, estado por paragem, a ordem otimizada |
Importar, geocodificar, otimizar, atribuir
POST /v1/integration-import HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
{
"external_job_id": "WMS-2026-07-30-A",
"driver_email": "driver@fleet.com.au",
"optimize": true,
"stops": [
{ "external_stop_id": "SO-88214",
"address": "3/216 Brunswick St, Fitzroy VIC 3065",
"parcel_count": 2,
"duration_minutes": 4 }
]
}{
"job_id": "job_7Yq2c",
"external_job_id": "WMS-2026-07-30-A",
"assigned_to": "driver@fleet.com.au",
"optimized": true,
"stops_imported": 142,
"stops": [
{ "external_stop_id": "SO-88214",
"stop_id": "stp_9f2",
"sequence": 38,
"status": "pending" }
],
"warnings": []
}Os seus identificadores mantêm-se
Cada identificador que envia volta à saída, no trabalho e em cada paragem. Nunca precisa de manter uma tabela de correspondência entre os seus números de encomenda e os nossos.
| external_job_id | A sua própria referência de lote — volta em cada paragem, por isso não precisa de tabela de correspondência |
| external_stop_id | O seu número de encomenda ou de expedição, transportado até ao estado e à conclusão |
| address | Uma só linha de morada; geocodificada na importação, as falhas voltam como avisos |
| parcel_count | Usado para as hipóteses de carga e manuseamento na paragem |
| duration_minutes | Tempo de serviço à porta — gasto no modelo, não dado por adquirido |
| driver_email | Atribui a rota concluída a um condutor que já está na conta |
O que faz quando corre mal
Escritas idempotentes
Reimportar o mesmo external_job_id atualiza o trabalho em vez de criar um segundo. Tentar de novo após um timeout é seguro.
Sucesso parcial
Uma paragem que não consiga ser geocodificada volta em warnings[] com o resto do trabalho importado. O pedido não falha por inteiro só porque uma morada está errada.
Versionamento
A versão está no caminho. Dentro de uma versão acrescentam-se campos, mas nunca são removidos nem reaproveitados, por isso uma integração escrita hoje continua a funcionar.
As chaves de sandbox são gratuitas
Desenvolva contra uma sandbox antes de se comprometer com o que quer que seja. Peça-nos e enviamos credenciais e um exemplo resolvido sobre o seu próprio formato de dados.