Saltar a contenido

API Preenvio (Pre-Shipment)

POST

Descripción

La API de preenvío permite dar de alta ordenes de envío de GlobAllPack. Posee un método POST en el cual se enviarán los datos necesarios para crear la orden y se recibirá como respuesta un numero de envío para poder realizar el seguimiento del mismo.

Endpoint

Body

{
    "ContratoUltimaMilla": "5000000",
    "ContratoCourier": "190684",
    "NumeroEnvioTerceros": "123456789",
    "NumeroGuiaHija": "GUIA-HIJA-EJEMPLO",
    "IdPedido": "120003",
     "Origen": {
        "Postal": {
            "Pais" : "US",
            "Localidad": "DORAL",
            "CodigoPostal": "33915",
            "Calle": "NW 37th Street",
            "Numero": "7801",
            "Region": "Florida",
            "ComponentesDeDireccion": null
        }
    },
    "Destino": {
        "Postal": {
            "Pais" : "ARG",
            "Localidad": "LA PLATA",
            "CodigoPostal": "1900",
            "Calle": "Avenida Principal",
            "Numero": "4600",
            "Region": "Buenos Aires",
            "ComponentesDeDireccion": [
                {
                  "Meta": "piso",
                  "Contenido": "1"
                },
                {
                  "Meta": "departamento",
                 "Contenido": "D"
                },
                {
                  "Meta": "Observaciones",
                 "Contenido": "Edificio blanco antes de la esquina"
                }
            ]
        }
    },
    "Remitente": {
        "NombreCompleto": "Juan Pérez",
        "Email": "[email protected]",
        "DocumentoTipo": "1",
        "DocumentoNumero": "99999999",
        "Telefonos": [
            {
              "Tipo": 1,
              "Numero": "11112234"
            }
        ]
    },
    "Destinatario": 
        {
            "NombreCompleto": "Adrian Lopez",
            "Email": "[email protected]",
            "DocumentosIdentidad": [
                {
                   "DocumentoTipo": "DNI",
                   "DocumentoNumero": "99999999"
                },
                {
                  "DocumentoTipo": "CUIL",
                  "DocumentoNumero": "20-99999999-7"
                }

            ],
            "Telefonos": [
                {
                  "Tipo": 1,
                  "Numero": "11233412"
                }
            ]
        }
    ,
    "Bultos": [
        {
          "ReferenciaTracking": "TRK-91860000002",
          "OperadorLogisticoOrigen" : "amazon",
          "Kilos": 1,
          "AltoCm": 23,
          "AnchoCm": 28,
          "LargoCm": 37,
          "VolumenCm": 23828,
           "Referencias": [
              {
                "Meta": "idCliente",
                "Contenido": "120003"
              }, 
              {
                "Meta": "Observaciones",
                "Contenido": "El producto es frágil"
              }
            ],
            "Productos": [
                {
                 "Descripcion": "descripcion producto",
                  "Categoria": "",
                  "Url": "https://tiendaonline/producto",
                  "Cantidad": 1,
                  "HSCODE": "61052020",
                  "ValorUnitario": 5000.70,
                  "ValorFOB": 600,
                  "SKUWeight": 3.82,
                  "Cif": 200.2
                }
            ], 

            "Factura" : {
                "url" : "",
                "base64" : ""
            }
        }
    ],
    "Remito": {
        "NumeroRemito": "120003"
    }
}

Campos del Body

CAMPO DESCRIPCIÓN REQUERIDO LONGUITUD OBSERVACIÓN
ContratoUltimaMilla Contrato para dar de alta envío en Andreani SI
ContratoCourier Contrato dedicado al tipo de servicio Courier SI
NumeroEnvioTerceros Número de envío asignado por un tercero u operador logístico externo NO
NumeroGuiaHija Número de guía hija asociada a la orden NO
IdPedido Id del envío por parte del cliente. SI
Origen.Postal.Pais Pais origen del envío (Codigo internacional de país) SI Más info en validaciones especiales
Origen.Postal.Localidad Localidad /Ciudad de origen del envío SI 40 Mas info en validaciones especiales
Origen.Postal.CodigoPostal Código postal localidad/Ciudad de origen del envio SI Mas info en validaciones especiales
Origen.Postal.Calle Calle de origen del envío SI 40 Más info en validaciones especiales
Origen.Postal.Numero Numeración de la calle de origen del envío NO 40 Más info en validaciones especiales
Origen.Postal.Region Provincia/estado/región de origen del envío (Código ISO o nombre) SI Más info en validaciones especiales
Origen.ComponentesDeDireccion Permiten administrar mas información del lugar de origen. Por ejemplo, piso y departamento NO Más info en validaciones especiales
Destino.Postal.Pais Pais Destino del envío (Codigo internacional del país) SI Más info en validaciones especiales
Destino.Postal.Localidad Localidad /Ciudad de destino del envío SI 40 Más info en validaciones especiales
Destino.Postal.CodigoPostal Código postal localidad/Ciudad de destino del envio SI Más info en validaciones especiales
Destino.Postal.Calle Calle de Destino del envío SI 40
Destino.Postal.Numero Numeración de la calle de destino del envío NO 40
Destino.Postal.Region Provincia/estado de destino del envío SI Más info en validaciones especiales
Destino.ComponentesDeDireccion Permiten administrar mas información del lugar de destino . Por ejemplo, piso y departamento. NO Mas info en validaciones especiales
Remitente.NombreCompleto Nombre y apellido del remitente SI 40
Remitente.Email email remitente SI 40
DocumentoTipo Indicar el valor 1. NO
DocumentoNumero número de documento del remitente NO
Remitente.Telefonos.Tipo Indicar el valor 1. NO
Remitente.Telefonos.Numeros número de telfono del remitente NO
Destinatario.NombreCompleto nombre completo del destinatario del envío SI 40
Destinatario.Email mail de destinatario SI 40
Destinatario.DocumentosIdentidad es requerido indicar el DNI y el CUIL/CUIT del destinatario SI 20 Más info en validaciones especiales
Destinatario.Telefonos.Tipo Indicar el valor 1. SI
Destinatario.Telefonos.Numero Número de celular del destinatario SI
bultos.ReferenciaTracking Este campo se puede utilizar para informar el número de seguimiento que lleva el paquete desde el origen. No
bultos.OperadorLogisticoOrigen Nombre de la persona/empresa que despacha el producto desde el origen hacia el operador logístico encargado de enviar el paquete hacia destino. NO
bultos.kilos peso en kilos del bulto SI 12.2
bultos.AltoCm alto en centímetros del bulto SI
bultos.AnchoCm Ancho en centímetros del bulto SI
bultos.LargoCm largo en centímetros del bulto SI
bultos.Volumen volumen del bulto SI 6.2 Si está este valor, las medidas pasan a ser opcionales
bultos.Refencias Objeto Meta-Contenido. Debe indicarse la propiedad idcliente con referencia al IdPedido. Se pueden agregar observaciones adicionales SI Mas info en validaciones especiales
bultos.Productos.Descripcion Descripcion completa del producto que se encuentra dentro de la caja. Incluir materiales de construcción e información detallada SI
bultos.Productos.Categoria categoria a la cual pertenece el producto NO
bultos.Productos.Url link de compra del producto NO
bultos.Productos.Cantidad cantidad del prodcuto presente SI
bultos.Productos.HSCODE Codigo de clasificacion aracelaria del producto. Este código debe tener un mínimo 6 dígitos y un máximo 11. NO 6-11
bultos.Productos.ValorUnitario precio del producto por unidad SI
bultos.Productos.ValorFOB precio del producto una vez que se encuentra en un medio de transporte SI
bultos.Productos.SKUWeight Peso del producto en Stock Keeping Unit. NO
bultos.Productos.Cif Valor CIF del producto. NO
bultos.Factura.Url Url que descarga factura de compra del contenido del bulto. NO Si provee la factura, debe ser la url o el Base64, no los dos juntos
bultos.factura.base64 base64 de la factura de compora del contenido del bulto NO Si provee la factura, debe ser la url o el Base64, no los dos juntos
Remito.NumeroRemito número de remito de la compra NO


Validaciones especiales


Dirección de origen

En caso de que el servicio y contrato indiquen que el cliente/proveedor informa el envío a GlobAllPack y lo transporta hasta el país de destino, se valida que el país y región de origen cumplan con el standard ISO CODE 3166.

📊 Regiones admitidas para US (Estados Unidos) y CN (China)

En caso de que el servicio y contrato indiquen que el envío hace utilidad de un proveedor internacional (GlobAllPack informa a proveedor internacional el envío creado) se debe indicar la dirección especifica del mismo para que la API transmita la información.

Posibles opciones de este último caso:

Origen Operador Dirección
USA TransExpress
        "Postal": {
            "Pais" : "US",
            "Localidad": "DORAL",
            "CodigoPostal": "33915",
            "Calle": "NW 37th Street",
            "Numero": "7801",
            "Region": "Florida",
            "ComponentesDeDireccion": null
        }
                    

Dirección de destino

Los datos de destino deben coincidir con los normalizados por Andreani:

API: https://apis.andreani.com/v1/localidades (no requiere autenticación)

info y documentación: https://developers.andreani.com/document

Transporte y distribución -> datos maestros -> Localidades

Documentos de identidad del destinatario

Es requerido indicar el DNI y el CUIL/CUIT del destinatario, e informarlo de la siguiente forma en el array de DocumentosIdentidad dentro del objeto Destinatario.

{
 "Destinatario": 
        {

            "DocumentosIdentidad": [
                {
                    "DocumentoTipo": "DNI",
                    "DocumentoNumero": "99999999"

                },
                {
                    "DocumentoTipo": "CUIL",
                    "DocumentoNumero": "20-99999999-7"

                }

            ]
        }
}

Referencias de bulto

Debe asociarse el bulto/caja al IdPedido con el meta "IdCliente"

{
"IdPedido" : "120003",
 "Bultos": [
    {
      "ReferenciaTracking": "COD4535",
      "Kilos": 1,
      "AltoCm": 23,
      "AnchoCm": 28,
      "LargoCm": 37,
      "VolumenCm": 23828,
        "Referencias": [
          {
            "Meta": "idCliente",
            "Contenido": "120003"
          }
        ]
    }
 ]
}

De manera opcional, pueden indicarse observaciones sobre la caja/bulto

{
 "Bultos": [
    {
      "ReferenciaTracking": "COD4536",
      "Kilos": 1,
      "AltoCm": 23,
      "AnchoCm": 28,
      "LargoCm": 37,
      "VolumenCm": 23828,
        "Referencias": [
          {
            "Meta": "Observaciones",
            "Contenido": "La caja contiene productos de cristal"
          }
        ]
    }
 ]
}

Response

Status 202 (Accepted)

{
    "envios": [
        {
            "numeroEnvio": "360000445193980",
            "numeroBulto": "1",
            "etiqueta": "https://apietiqueta.com/v2/ordenes-de-envio/0001111771336/etiquetas?bulto=1"
        }
    ],
    "etiquetaAgrupador": "https://apietiqueta.com/v2/ordenes-de-envio/0001111771336/etiquetas",
    "sucursalDeDistribucion": {
        "nomenclatura": "LPC",
        "descripcion": "LA PLATA (CALLE 2)",
        "id": "177"
    },
    "sucursalDeRendicion": {
        "nomenclatura": "RZS",
        "descripcion": "AVELLANEDA (LOG INVERSA ZS)",
        "id": "284"
    },
    "contrato":"22222222",
    "cliente": "00128889889",
    "numeroDePermisionaria": "RNPSP Nº 586",
    "descripcionServicio": "Encomienda eCommerce",
    "canal": "B2C"
}
CAMPO DESCRIPCIÓN
envios.numeroEnvio Número de envío asignado al bulto/paquete. Es el número de seguimiento en todo el ciclo de vida del envío
envios.numeroBulto Identificador del bulto/paquete en la orden de envío
envios.etiqueta El link permite obtener la etiqueta de envío asociada al bulto/paquete
etiquetaAgrupador Permite obtener todas las etiquetas de los bultos dentro de la orden de envío


Status 202 (Accepted)

Si los datos del envío son correctos, pero se detectan errores en las facturas, la solicitud será aceptada de todas formas. En el Response se informará al usuario que hubo un error al guardar la factura. Luego de creado el envío es posible volver a enviar las facturas con el método PUT .

{
    "envios": [
        {
            "numeroEnvio": "360000445193980",
            "numeroBulto": "1",
            "etiqueta": "https://apietiqueta.com/v2/ordenes-de-envio/0001111771336/etiquetas?bulto=1"
        }
    ],
    "etiquetaAgrupador": "https://apietiqueta.com/v2/ordenes-de-envio/0001111771336/etiquetas", 
     "errorFactura": [
        {
            "status": 400,
            "url": null,
            "mensaje": "Validation failed: \n -- Base64: El valor debe ser Base64 válido. Severity: Error"
        }
    ]
}


Status 400 (BadRequest)

Ocurre cuando falta un dato obligatorio.

[
    {
        "Code": "NotEmptyValidator",
        "Property": "Request.Destino.Postal.CodigoPostal",
        "Message": "El campo CodigoPostal en Destino es obligatorio."
    }
]


Status 400 (BadRequest)

Ocurre cuando algún dato no es válido.

{
    "error": {
        "titulo": "Error de validación",
        "mensaje": "No se encuentran sucursales para los filtros ingresados"
    }
}


PUT

Descripción

El método PUT ofrece la posibilidad de enviar las facturas de compra de los paquetes luego de haber creado una orden de envío.

Endpoint

Body

{
    "numeroEnvio" : "360000445193920",

    "Factura" : {
        "url" : "",
        "base64" : ""
    }
}
CAMPO DESCRIPCIÓN
numeroEnvio Número de seguimiento que fue informado al crear la orden de envío
Factura.url Campo para adjuntar URL fr de la factura. Debe poder accederse sin autenticación
Factura.base64 Campo para adjuntar la factura en formato BASE64

Se debe informar la factura en formato URL o base64, no ambos.

El documento debe tener formato PDF.


Response

Status 200 (OK)

{
    "envios": [
        {
            "numeroEnvio": "360000445193980",
            "numeroBulto": "1",
            "etiqueta": "https://apietiqueta.com/v2/ordenes-de-envio/0001111771336/etiquetas?bulto=1"
        }
    ],
    "etiquetaAgrupador": "https://apietiqueta.com/v2/ordenes-de-envio/0001111771336/etiquetas"
}


Status 400 (BadRequest)

Ocurre cuando hay problemas con el formato de archivo enviado.

{
    "errorFactura": [
        {
            "status": 400,
            "url": null,
            "mensaje": "El archivo proporcionado no es un Pdf válido."
        }
    ]
}


Status 404 (NotFound)

Ocurre cuando se indica un número de envío inexistente.

{
    "error": {
        "titulo": "NotFound",
        "mensaje": "No se ha encontrado un envio con el numero 3600004451888"
    }
}

GET (ETIQUETAS)

Descripción

Cuando se crea una orden de envío, la respuesta incluye una URL desde la cual se pueden obtener las etiquetas. Estas etiquetas están disponibles en formato PDF (por defecto) o en formato ZPL. El tamaño de las etiquetas es de 15 centímetros de largo por 10 centímetros de ancho.

  • Es posible obtener la etiqueta de un envío por número de envío: ordenes-de-envio/{numeroEnvio}/etiquetas
  • Si se desean todas las etiquetas de una orden se debe consultar el campo "etiquetaAgrupador" del Response luego de crear la orden de envío con el método POST.

Endpoint

ZPL

Para obtener la respuesta en formato ZPL se debe incluir el siguiente encabezado en la solicitud:

Accept: application/zpl

Mapeo de Etiqueta

Etiqueta

```

Ejemplo en Postman:

alt text