Buscar na documentação

Módulos

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Soluções

Logistics

Introdução

A API de Logistics gerencia operações de entrega.

Receber pedidos

Consulte novos pedidos a cada 30 segundos usando:

Obrigatório no polling: Use o parâmetro excludeHeartbeat para evitar abertura indevida da loja.Exemplo: /events/v1.0/events:polling?excludeHeartbeat=true

Polling para eventos de pedidos

Configure o polling para receber eventos de pedidos

Webhook para eventos de pedidos

Configure webhooks para receber eventos de pedidos

Obter detalhes do pedido

Use GET logistics/orders/{id} para obter detalhes do pedido.Respostas:

200: Retorna dados do pedido
404: ID inválido ou pedido não encontrado

Detalhes do pedido

Consulte todos os campos disponíveis no payload

Ações de logística

Alocar entregador

Use POST /assignDriver para alocar um entregador ao pedido.Payload obrigatório:

{
  "workerName": "José Maria",
  "workerPhone": "11999999999",
  "workerVehicleType": "MOTORCYCLE"
}

Valores válidos para workerVehicleType: BICYCLE, ONFOOT, PATINETE, EBIKE, SUPERBIKE, CAR, MOTORCYCLE, MOTORBIKE

Notificar deslocamento para coleta

Use POST /goingToOrigin quando o entregador iniciar deslocamento para o local de coleta.

Confirmar chegada na origem

Use POST /arrivedAtOrigin quando o entregador chegar ao local de coleta.

Notificar deslocamento para entrega

Use POST /dispatch quando o entregador iniciar deslocamento para o local de entrega.

Confirmar chegada no destino

Use POST /arrivedAtDestination quando o entregador chegar ao local de entrega.

Verificação de entrega

Enviar código de verificação

Obrigatório para todas integradoras.Use POST /verifyDeliveryCode para validar a entrega.Payload obrigatório:

{
  "code": "9999"
}

Como funciona:

Verifique se o pedido requer validação pelo evento DELIVERY_DROP_CODE_REQUESTED
Solicite o código ao destinatário
Envie o código via endpoint

Exemplo do evento:

{
  "id": "f24e3b11-d292-48f0-a74b-e984575a1a0a",
  "code": "DDCR",
  "fullCode": "DELIVERY_DROP_CODE_REQUESTED",
  "orderId": "9c964c28-c833-44bb-9457-9b9accca3a6c",
  "merchantId": "b8ce1930-463b-4794-80b4-1823c261c1fb",
  "createdAt": "2023-04-17T17:56:39.029Z"
}

Esta página foi útil?

Avalie sua experiência no novo Developer portal:

Nesta página