Skip to main content
Version: Latest

Despachar un pedido

Genera la guía de un pedido y devuelve en una sola respuesta el número, el rótulo, el PDF y el estado.

Request 🚀​

url​

https://app.aveonline.co/avestock/api/dispatchOrder.php

Method​

POST

Content-Type: application/json
Authorization: {data.token}

El data.token se obtiene en la Autenticación.

Params JSON​

  • tipo* String Enrutador de la API, "authave"
  • empresa* Number Identificador de la empresa dentro de AVEONLINE
  • order_id* String Consecutivo del pedido o número de pedido externo. Solo dígitos

Ejemplo​

{
  "tipo": "authave",
  "empresa": 6077,
  "order_id": "43129108328094224"
}

Response 📄​

Success​

  • order_id String Consecutivo del pedido en AveCRM
  • already_dispatched Bool false cuando la guía se generó en este llamado
  • guide_pending Bool true cuando la guía se generó pero todavía no tiene número asignado
  • order_status.id / name Number / String Estado del pedido tras el despacho
  • guide.number String Número de guía
  • guide.carrier String Transportadora
  • guide.guide_url String PDF de la guía. Vacío en mensajería propia
  • guide.label_url String Rótulo para imprimir. Vacío en mensajería propia
  • guide.tracking_url String Enlace público de rastreo

Ejemplo​

{
  "success": true,
  "messages": "Guia generada",
  "status": 200,
  "data": {
    "order_id": "43129108328094224",
    "external_order_id": "PED-9912",
    "already_dispatched": false,
    "order_status": { "id": 10000, "name": "Procesando guía" },
    "guide": {
      "number": "240064570238",
      "carrier": "INTERRAPIDISIMO",
      "status": "Solicitada",
      "status_id": 1,
      "guide_url": "https://.../guia.pdf",
      "label_url": "https://.../rotulo.pdf",
      "tracking_url": "https://app.aveonline.co/buscarguia.php?guia=240064570238"
    }
  }
}

La guía todavía no tiene número​

El número de guía no siempre está listo cuando el servicio responde: asignarlo toma unos 15 segundos. Cuando eso pasa, la respuesta llega con estado 202 y guide_pending en true.

El pedido ya quedó despachado. No lo vuelva a despachar: consulte el pedido unos segundos después para obtener el número, el rótulo y el enlace de rastreo. Un segundo despacho responde 409 porque el pedido ya tiene guía.

{
  "success": true,
  "messages": "La guia se esta generando y todavia no aparece en AveCRM. Suele tardar unos 15 segundos. NO vuelva a despachar este pedido: consulte el pedido para obtener el numero.",
  "status": 202,
  "data": {
    "order_id": "43129108328094224",
    "external_order_id": "PED-9912",
    "already_dispatched": false,
    "guide_pending": true,
    "order_status": { "id": 1, "name": "Solicitada" },
    "guide": {
      "number": "",
      "carrier": "",
      "status": "",
      "status_id": null,
      "guide_url": "",
      "label_url": "",
      "tracking_url": ""
    }
  }
}

El pedido ya tiene una guía activa​

No se genera una segunda. Se devuelve la que ya existe.

{
  "success": false,
  "messages": "El pedido ya tiene una guia activa.",
  "status": 409,
  "data": {
    "order_id": "43129108328094224",
    "already_dispatched": true,
    "guide": {
      "number": "240064570238",
      "carrier": "INTERRAPIDISIMO",
      "tracking_url": "https://app.aveonline.co/buscarguia.php?guia=240064570238"
    }
  }
}

El pedido no existe o no es de la empresa​

{
  "success": false,
  "messages": "El pedido 43129108328094224 no existe o no pertenece a esta empresa.",
  "status": 404
}

El pedido está anulado​

{
  "success": false,
  "messages": "El pedido 43129108328094224 esta anulado.",
  "status": 409
}

No se pudo generar la guía​

Cubre sin inventario disponible, sin operador de envío asignado, sin cobertura en el destino y rechazos de la transportadora. El mensaje concreto viaja en messages y el detalle completo en data.detail.

{
  "success": false,
  "messages": "No hay inventario disponible para despachar el pedido.",
  "status": 400,
  "data": {
    "order_id": "43129108328094224",
    "detail": {}
  }
}

Notas Importantes 📝​

  1. Nunca genera una segunda guía. Si el pedido ya tiene una activa se devuelve esa con estado 409. Dos guías para el mismo pedido significan dos envíos cobrados y uno solo despachado.
  2. order_id acepta tanto el consecutivo de AveCRM como el número de pedido externo con el que se creó.
  3. El servicio aplica las mismas validaciones de inventario que la pantalla, incluido el bloqueo cuando no hay stock suficiente.
  4. Los enlaces de guía y rótulo se leen de lo que quedó guardado en AveCRM, que es contra lo que se debe conciliar después.
  5. Un 202 no es un fallo. Significa que el pedido ya quedó despachado y que el número de guía está en camino. Trate 200 y 202 como éxito, y distíngalos solo para saber si ya puede imprimir el rótulo. Reintentar el despacho ante un 202 es el único error que puede cometer acá.
  6. La mensajería propia no emite PDF ni rótulo. guide_url y label_url llegan vacíos y eso es correcto: esos archivos los produce la transportadora, y en un reparto con mensajero propio no hay transportadora. El número de guía y el enlace de rastreo sí llegan.