Webhook estados de la guía

Cada vez que cambia el estado de una guía, AVEONLINE notifica el cambio al Webhook personalizado que la empresa haya registrado.

¿Cómo se activa?

El proceso es general para todas las transportadoras. Para recibir las notificaciones, la empresa debe registrar un "Webhook personalizado" en el panel de Mis integraciones:

https://guias.aveonline.co/panel/mis-integraciones

Al registrar la integración se definen:

• token String Token que identifica la integración, se reenvía en cada notificación.
• webhook url String Ruta a la cual AVEONLINE enviará la trama del estado.

Cuando los procesos de actualización de estados detectan un cambio en una guía cuya empresa tenga un webhook personalizado activo, se envía automáticamente la trama a la url registrada.

Request

url

Ruta registrada en el Webhook personalizado de Mis integraciones

Method

POST

Header

Content-Type: application/json

Params JSON

• token String Token de la integración registrada en Mis integraciones.
• guia String Número identificador de la guía.
• pedido_id String Número de pedido interno asociado al envío.
• numeropedidoExterno String Número de pedido externo cargado desde la generación del pedido.
• estado Array Object -> [{}]
  • estado_id String Código del estado del envío.
  • nombre_estado String Descripción del estado.
  • fechacreacion String Fecha de registro del estado.
  • fechanovedad String Fecha de la novedad, en caso que aplique.
  • comentarionovedad String Descripción de la novedad, en caso que ocurra.
  • complementariosnovedad String Información complementaria de la novedad, en caso que ocurra.
  • tiponovedad String Tipo de novedad.
• guiadigitalizada String Ruta que redirecciona al PDF de la guía digitalizada.
• fechaentrega String Fecha de entrega del envío.

Ejemplo

{
  "token": "000000^cZtUEYw",
  "guia": "1112016134910111",
  "pedido_id": "2222281115431432",
  "numeropedidoExterno": "00000",
  "estado": [
    {
      "estado_id": "12",
      "nombre_estado": "Entregada",
      "fechacreacion": "2023/06/02 12:37:58 pm",
      "fechanovedad": "2023-12-02 16:04:06",
      "comentarionovedad": "DESTINATARIO SE TRASLADO",
      "complementariosnovedad": "13:21 : NOMBRE CONFIRMA NUEVA DIRECCION: dueñoNUEVA DIRECCION: 0000 ",
      "tiponovedad": "SC"
    }
  ],
  "guiadigitalizada": "",
  "fechaentrega": "2023/06/02 10:01:00 am"
}

Response

El webhook del cliente debe responder confirmando la recepción.

Success

{
  "success": true,
  "messages": "Proceso realizado"
}

Error

{
  "success": false,
  "messages": "No hay numero de guia valido o la empresa no posee webhook"
}