Glossário

Vocabulário da API de entregas

Cada termo usado pela API, pelo console e pelo app do motorista, em uma frase, com link para onde importa.

Aceite automáticoVer →: Regras que o motorista define (distância, tamanhos, horários, zonas) para que ofertas compatíveis sejam aceitas em segundos.
Adicional de retornoVer →: A parte do preço cidade a cidade que cobre a volta vazia do motorista: metade da distância e do tempo de direção da ida.
Área de serviçoVer →: Uma cidade de lançamento com centro, raio e tarifa própria; check_coverage recusa cotações fora de qualquer área.
Assinatura de webhookVer →: Um cabeçalho HMAC em cada webhook para verificar que o evento veio da RentADriver; envios de teste pelo console.
Avaliação do destinatárioVer →: A nota de 1 a 5 que o destinatário deixa na página de rastreamento após a entrega; motoristas veem a média.
CarteiraVer →: O saldo pré-pago que financia uma entrega; recarregue com cartão ou USDC e veja cada movimento no console.
Catálogo de endereçosVer →: Locais de coleta e entrega salvos com contatos, usáveis pelo console e pela API.
Chave sandboxVer →: Uma chave de teste que você gera na página de preços ou no console para testar o fluxo inteiro sem gastar nada.
Cidade a cidadeVer →: Entrega no mesmo dia de uma cidade de lançamento para uma cidade de lançamento vizinha a até 160 km por estrada, com um motorista dedicado.
Classe de tamanhoVer →: S (envelope ou sacola), M (caixa de sapato a mochila), L (mala) ou XL (precisa de van); escala o preço e filtra quais motoristas recebem a oferta.
Comprovante de entregaVer →: Fotos geolocalizadas, assinatura ou código de uso único capturados na entrega e retornados por get_proof_of_delivery.
ConfirmarVer →: Sua aceitação do comprovante, que captura os fundos; se não chamar, a entrega se confirma sozinha 24 horas após a entrega.
CotaçãoVer →: Uma oferta com preço e rota para uma entrega, retornada por POST /v1/quotes com detalhamento e ETAs; grátis, sem chave, válida por 15 minutos.
EntregaVer →: Um trabalho reservado de uma coleta a uma ou mais entregas, com linha de status, comprovante e link de rastreamento.
Entrega com OTPVer →: Um código de uso único que você coloca nos metadados; o destinatário lê ao motorista e o trabalho não fecha sem ele.
Entrega recorrenteVer →: Um modelo que se reserva sozinho nos dias e horários escolhidos; gerenciado no console e pelo worker recorrente.
Horário limite do mesmo diaVer →: Uma entrega cidade a cidade precisa chegar até as 21h, horário local; uma reserva tarde demais para isso é coletada na manhã seguinte.
Link de rastreamentoVer →: Uma página pública por entrega com status ao vivo, posição do motorista e ETA, personalizável com seu logo e cores.
MarcoVer →: Um passo registrado de uma entrega, como carga a bordo na coleta, que muda o que ainda pode ser cancelado.
Modo de testeVer →: Chaves de teste criam entregas is_test com motoristas simulados e sem movimento de carteira; o console as mostra sob um aviso de sandbox.
OfertaVer →: Um trabalho proposto a um motorista no RentADriver Go com os detalhes; aceito com um toque ou automaticamente pelas regras dele.
Onda de despachoVer →: Uma rodada de ofertas enviada a motoristas em turno perto da coleta; o raio cresce onda a onda até alguém aceitar.
ParadaVer →: Um endereço de coleta ou entrega com contato; uma entrega local aceita até 8 entregas, uma de cidade a cidade até 3.
quote_idVer →: O identificador de uma cotação; passe-o ao create_delivery para reservar exatamente por esse preço.
Reserva e capturaVer →: O preço integral é reservado na sua carteira ao reservar e capturado ao confirmar; cancelamentos liberam a reserva.
Servidor MCPVer →: rentadriver-mcp, o servidor Model Context Protocol que expõe cada capacidade da API como ferramentas para um agente.
Tarifa dinâmicaVer →: Um multiplicador ao vivo quando a demanda supera a oferta próxima; sempre visível no detalhamento.
TurnstileVer →: A verificação humana opcional em cadastros pelo navegador; agentes, servidor MCP e curl são isentos.
UrgênciaVer →: asap, today ou scheduled; define a janela de despacho e um dos multiplicadores de preço.
Valor declaradoVer →: value_cents que você define em um item: fica registrado com a entrega para avaliar uma reclamação por perda ou dano.