Rastreo de guía

GET 
/webhook-maestro/query/estado-guia/:num_guia

Este endpoint permite a los usuarios rastrear el estado actual de una guía de envío mediante la introducción del número de guía correspondiente. Al realizar esta consulta, el sistema devuelve información detallada sobre la ubicación y el estado del paquete a lo largo de su trayecto. La respuesta incluye: Estado del paquete, Historial de movimientos e Información del Receptor.

Esta funcionalidad es fundamental para el seguimiento en tiempo real de los envíos, permitiendo a los usuarios gestionar de manera eficiente sus paquetes y proporcionar información actualizada a los destinatarios. La capacidad de rastrear guías de envío no solo mejora la experiencia del cliente, sino que también optimiza la logística y la planificación de envíos futuros.

Este endpoint devuelve dentro de los detalles del estado de la guía un estatus interno y externo los cuales se pueden consultar en la siguiente tabla:

Catálogo de estatus externos e internos:

familia_externa	familia_interna
In Process	Guia generada
Collected	Recolectado
Transit	En camino
Delivered	Entregado
Cancelled	Cancelado
Exception of delivery	Excepcion de entrega
Exception of delivery	Entrega fallida. Dirección de entrega incorrecta
Exception of delivery	Retornado a remitente

Request

Path Parameters

num_guia stringrequired

Número de guía a consultar.

Responses

200

Respuesta de una petición del estado actual de guía en formato JSON. (La url final puede cambiar)

Response Headers

application/json

Schema

Schema

success boolean

Indica si la consulta fue exitosa.

message string

Mensaje que se muestra al obtener la respuesta de la consulta.

detail

object

Detalles del estado actual de la guía.

id_seller string

Identificador del seller.

codigo string

Código de estado de la guía.

descripcion string

Descripción del código de estado de la guía.

familia_interna string

Identificador de la familia interna (si aplica).

familia_externa string

Identificador de la familia externa (si aplica).

guia string

Número de guía consultada.

fecha string

Fecha del evento registrado.

recibe string

Nombre de la persona que recibe el paquete (si aplica).

fecha_estimada string

Fecha estimada de entrega del paquete.

id_mensajeria string

Id de la mensajería.

guia_retorno string

Example (from schema)

{
  "success": true,
  "message": "string",
  "detail": {
    "id_seller": "string",
    "codigo": "string",
    "descripcion": "string",
    "familia_interna": "string",
    "familia_externa": "string",
    "guia": "string",
    "fecha": "string",
    "recibe": "string"
  }
}

Estructura de Response:

{
  "success": true,
  "message": "Petición exitosa!",
  "detail": {
    "id_seller": "1",
    "codigo": "4",
    "descripcion": "Producto entregado",
    "familia_interna": "0",
    "familia_generica": "",
    "guia": "0122445",
    "fecha": "2021-08-18T10:00:39.178463435",
    "recibe": "Jhon Snow"
  }
}

400

Posibles errores debido a que no se pudo realizar la consulta.

Response Headers

application/json

Schema

Schema

success boolean
message string
error string

Example (from schema)

{
  "success": true,
  "message": "string",
  "error": "string"
}

Posibles errores debido a que no se pudo realizar la consulta.

{
  "success": false,
  "message": "Error al pocesar petición",
  "error": "La guia numero_guia no existe"
}

Loading...