Buscar en la documentación

Módulos

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Soluciones

Logistics

Introducción

La API de Logistics gestiona operaciones de entrega.

Recibir pedidos

Consulte nuevos pedidos cada 30 segundos usando:

Obligatorio en polling: Use el parámetro excludeHeartbeat para evitar apertura indebida de la tienda.Ejemplo: /events/v1.0/events:polling?excludeHeartbeat=true

Polling para eventos de pedidos

Configure el polling para recibir eventos de pedidos

Webhook para eventos de pedidos

Configure webhooks para recibir eventos de pedidos

Obtener detalles del pedido

Use GET logistics/orders/{id} para obtener detalles del pedido.Respuestas:

200: Retorna datos del pedido
404: ID inválido o pedido no encontrado

Detalles del pedido

Consulte todos los campos disponibles en el payload

Acciones de logística

Asignar repartidor

Use POST /assignDriver para asignar un repartidor al pedido.Payload obligatorio:

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

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

Notificar desplazamiento para recolección

Use POST /goingToOrigin cuando el repartidor inicie desplazamiento al lugar de recolección.

Confirmar llegada al origen

Use POST /arrivedAtOrigin cuando el repartidor llegue al lugar de recolección.

Notificar desplazamiento para entrega

Use POST /dispatch cuando el repartidor inicie desplazamiento al lugar de entrega.

Confirmar llegada al destino

Use POST /arrivedAtDestination cuando el repartidor llegue al lugar de entrega.

Verificación de entrega

Enviar código de verificación

Obligatorio para todas las integradoras.Use POST /verifyDeliveryCode para validar la entrega.Payload obligatorio:

{
  "code": "9999"
}

Cómo funciona:

Verifique si el pedido requiere validación por el evento DELIVERY_DROP_CODE_REQUESTED
Solicite el código al destinatario
Envíe el código vía endpoint

Ejemplo del 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 fue útil?

Evalúa tu experiencia en el nuevo portal de desarrolladores:

En esta página