Version: Latest

Generación de guía

Se realiza el proceso de generacion de guía

Request 🚀

url

https://app.aveonline.co/api/nal/v1.0/generarGuiaTransporteNacional.php

Method

POST

Content-Type: application/json

Params `JSON`

tipo* String Enrutador de la API, "generarGuia2"
token* String Token recibido en la Autenticación con vigencia de una hora
idempresa* Number Identificador del usuario dentro de AVEONLINE, se obtiene en la Autenticación
codigo* String Usuario de ingreso a la plataforma
dsclavex* String Contraseña de ingreso a la plataforma
plugin* String
origen* String Ciudad de origen o codigo DANE correspondiente, se obtiene del Listado de ciudades
dsdirre* String Dirección del remitente
dsbarrioo String Barrio del remitente
destino* String Ciudad de destino o codigo DANE correspondiente, se obtiene del Listado de ciudades
dsdir* String Direccion del destinatario
dsbarrio String Barrio del destinatario
dsnitre* String Nit, cédula o documento de identidad del remitente
dstelre* String Número de teléfono del remitente
dscelularre* String Número de celular del remitente
dscorreopre* String Correo electrónico del remitente
dsnit* String Nit, cédula o documento de identidad del destinatario
dsnombre* String Nombre del remitente
dsnombrecompleto* String Nombre completo del destinatario
dscorreop* String Correo electrónico del destinatario
dstel* String Número de teléfono del destinatario
dscelular* String Número de celular del destinatario
idtransportador* String Identificador de la transportadora procedente del Listado de operadores logísticos o de la Cotización
unidades* Number Unidades de empaque
productos* Array Object -> [{}]
- alto String Dimensión de alto del producto
- largo String Dimensión de largo del producto
- ancho String Dimensión de ancho del producto
- peso* String Peso del producto
- unidades* Number Cantidad de productos con estas mismas características
- nombre* String Descripción del producto
- valorDeclarado* String Costo de la mercancia, de cada producto
dscontenido* String Lo que contienen los paquetes
dscom* String Comentarios adicionales
idasumecosto* Number Si el cliente asume el costo del servicio de recaudo: 1. Si no: 0
contraentrega* Number Si el cliente asume el costo del envio: 1. Si no: 0
valorrecaudo* Number Valor que se requiere recaudar
idagente* String Agente asociado a la cuenta del usuario, se obtiene del Listado de agentes
dsreferencia String Referencias adicionales
dsordendecompra String Identificador que agrupa una cantidad determinada de guias relacionadas a una orden de compra
bloquegenerarguia* String Si desea generar la guia: 1. Si no: 0
relacion_envios* String Si se va a realizar relación de envío de la guía generada: 1. Si no: 0
enviarcorreos* String Si desea enviar correo sobre con la informacion del envio: 1. Si no: 0
cartaporte String Boomerang. Si la guia es de ida y regreso: 1
valorMinimo Number Para asignar la valoracion minima ($10.000) a la unidad de empaque: 1. Para asignar la suma de valores declarados de cada producto: 0
numeroFactura String Es el numero de la factura que se va a asociar a esta guia
numeroBolsa String numero de bolsa, para el caso de la transportadora TCC
dsfecha_vencimiento Date Fecha de vencimiento OC (YYYY/MM/DD)
dsfecha_cita Date Fecha de cita OC (YYYY/MM/DD)
dscodigo_cita String Código de cita OC
dsvalor_pedido Number Valor del número de la factura que se va a asociar a esta guia

Ejemplo

{
  "tipo": "generarGuia2",
  "token": "iewruJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXNzaW9uIjo5MDU4OSwiZXhwIjoxNjIyNzQ3MDUyLCJhcHJvYmFkb3MiOls2MDc3XX0.hbYPRcsGe-T2YWQMxeUpIz_-iBNgeYs4cXysrxrmSBo",
  "idempresa": "6077",
  "codigo": "demo",
  "dsclavex": "Webservices",
  "origen": "MEDELLIN(ANTIOQUIA)",
  "dsdirre": "Cr 41 A # 6 S-93 - Av  El Poblado",
  "dsbarrioo": "",
  "destino": "MEDELLIN(ANTIOQUIA)",
  "dsdir": "Calle 49 sur 43 A 167 Bodega 103",
  "dsbarrio": "",
  "dsnitre": "9018329132",
  "dstelre": "3146622696",
  "dscelularre": "3146622696",
  "dscorreopre": "desarrollo@aveonline.co",
  "dsnit": "00000",
  "dsnombre": "prueba plugin",
  "dsnombrecompleto": "prueba plugin prueba plugin",
  "dscorreop": "desarrollo@aveonline.co",
  "dstel": "8298338",
  "dscelular": "3023723917",
  "idtransportador": "29",
  "unidades": 1,
  "productos": [
    {
      "alto": "10",
      "largo": "10",
      "ancho": "10",
      "peso": "1",
      "unidades": 2,
      "nombre": "Libros",
      "ref": "",
      "valorDeclarado": "46000"
    }
  ],
  "dscontenido": "Libros",
  "dscom": "",
  "idasumecosto": 0,
  "contraentrega": 0,
  "valorrecaudo": 20000,
  "idagente": "2600",
  "dsreferencia": "",
  "dsordendecompra": "",
  "bloquegenerarguia": "1",
  "relacion_envios": "1",
  "enviarcorreos": "1",
  "cartaporte": "",
  "valorMinimo": 0,
  "numeroFactura": "5501",
  "numeroBolsa": "244",
  "dsfecha_vencimiento": "2023/03/17",
  "dsfecha_cita": "",
  "dscodigo_cita": "011222",
  "dsvalor_pedido": "123000"


}

Response 📄

Success

status String Estado del resultado
message String Mensaje de respuesta
resultado Array Object -> [{}]
- guia Array Object -> [{}]
  - codigo String En caso de error devuelve el codigo identificador
  - mensaje String Mensaje devuelto por la transportadora
  - numguia Number Numero identificador de la guia generada
  - rutaguia String URL que contiene la guia para imprimir
  - archivoguia String Contiene el codigo de generación del archivo de impresión
  - rotulo String Contiene el rótulo de impresión
  - archivorotulo String Contiene el codigo de generación del rótulo de impresión
  - rotulozebra String Contiene el rótulo zebra de impresión
  - archivorotulozebra String Contiene el codigo de generación del rótulo zebra de impresión
  - transportadora String Nombre de la transportadora

Ejemplo

{
  "status": "ok",
  "message": "proceso correcto",
  "resultado": {
    "guia": {
      "codigo": "0",
      "mensaje": "Guia 21027846356 Generada",
      "numguia": 21027846356,
      "rutaguia": "https://app.aveonline.co/app/modulos/paqueteo/imprimir.guia.servientrega.php?idtransportadorx=33&amp;guia=2102474356",
      "archivoguia": "000",
      "rotulo": "https://app.aveonline.co/app/modulos/paqueteo/imprimir.rotulo.beta.php?pkid=1779251&amp;dsconsec=2102474356&amp;idagente=1055&amp;idexp=6077&amp;codagente=&amp;idcliente=79823&amp;idremitente=0&amp;imprimir=1&amp;idempresa=6077&amp;idtransportador=33",
      "archivorotulo": "JVBERi0xLjQKJeLj4567890iuygfgvbhjkio876tfghjui8786tgfhjui8786tygIC9QYWdlCi9QYXJlbnQgMSAwIFIKL01lZGlh\r\nQm94IFswIDAgNjEyLjAwMCA3OTIuMDAwXQovVHJpbUJveCBbMC4wMDAgMC4wMDAgNjEyLjAwMCA3\r\nOTIuMDAwXQovUmVzb3VyY2VzIDIgMCBSCi9yAwMDAwMCBuIAowMDAwMDE3MjM1IDAwMDAwIG4gCjAwMDAwMTc2MzEgMDAw\r\nMDAgbiAKMDAwMDAyOTg4MSAwMDAwMCBuIAowMDAwMDM1MTY4IDAwMDAwIG4gCjAwMDAwMzUzNTYg\r\nMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAyMwovUm9vdCAyMiAwIFIKL0luZm8gMjEgMCBSCi9J\r\nRCBbPDQ2MTA4ZDdkYjdiMjEyNWQ3MTI5MWZkMmFhMjVmZDk2PiA8NDYxMDhkN2RiN2IyMTI1ZDcx\r\nMjkxZmQyYWEyNWZkOTY+XQo+PgpzdGFydHhyZWYKMzU1MDYKJSVFT0Y=\r\n",
      "rotulozebra": "00",
      "archivorotulozebra": "00",
      "transportadora": "SERVIENTREGA"
    }
  }
}

Error

Tipificación de errores

codigo	mensaje	transportadora
-1	El origen no existe
-2	El destino no existe
-3	El peso no puede ser negativo o menor a cero
-4	Las unidades no puede ser negativas o menor a cero
-5	El valor declarado no puede ser negativo o menor a cero
-6	El nombre del remitente no existe
-7	La direccion de remitente no existe
-8	El telefono del remitente no existe
-9	El nombre del destinatario no existe
-11	La direccion del destinatario no existe
-12	El telefono del destinatario no existe
-13	El correo del destinatario no existe
-14	La transportadora no existe
-15	Debe indicar que contiene la guia
-16	El nit o identificacion del remitente no existe
-17	No se pudo generar la guia
-998	CLIENTE NO EXISTE EN EL SISTEMA

Productos= 0

{
  "status": "error",
  "message": "no se encontraron productos"
}

Credenciales incorrectas o token expirado

{
  "status": "error",
  "message": "credenciales incorrectas"
}

No se encuentran datos asociados

{
  "status": "error",
  "message": "se produjo un error al momento de iniciar la comunicacion"
}

Request 🚀​

url​

Method​

Header​

Params JSON​

Ejemplo​

Response 📄​

Success​

Ejemplo​

Error​

Tipificación de errores​

Productos= 0​

Credenciales incorrectas o token expirado​

No se encuentran datos asociados​

Request 🚀

url

Method

Header

Params `JSON`

Ejemplo

Response 📄

Success

Ejemplo

Error

Tipificación de errores

Productos= 0

Credenciales incorrectas o token expirado

No se encuentran datos asociados