Desarrollada por Urbano Express, esta API proporciona toda la informaci贸n necesaria para integrar su e-commerce con nuestros servicios log铆sticos.
Beneficios principales:
- Automatizaci贸n de procesos log铆sticos
- Consulta en tiempo real de tarifas de env铆o
- Seguimiento detallado de env铆os (tracking)
- Gesti贸n de puntos de retiro y sucursales
- Impresi贸n de etiquetas en m煤ltiples formatos (A4, Z10X10, Z10X6, ZPL)
- Normalizaci贸n de direcciones para mayor agilidad en log铆stica
- Consulta de peso y medidas del paquete
- Canalizaci贸n por c贸digo postal
- Soporte para m煤ltiples tipos de servicio (entrega, retiro, contra reembolso, sucursal)
- Integraci贸n flexible con m煤ltiples plataformas
Con nuestros servicios usted podr谩 disponer de los siguientes beneficios:
TRACKING:
El servicio de rastreo le permitir谩 saber en todo momento y de manera instant谩nea el estado de una pieza. Podr谩 brindarle a sus clientes la informaci贸n detallada del seguimiento de sus env铆os.
CONSULTA DE TARIFA:
El servicio de consulta de tarifa le permitir谩 mostrar a sus clientes el costo del env铆o al momento de efectuAR LA COMPRA. De este modo usted podr谩 adicionar el costo del env铆o autom谩ticamente al costo de venta en el eCommerce.
PEDIDO DE ENV脥O (CARGA CLIENTE):
Con el servicio de carga de pedidos usted seleccionar谩 qu茅 pedidos desea enviar. Como respuesta recibir谩 una etiqueta con el detalle del env铆o que puede imprimir y adosar al paquete.
PUNTOS DE RETIRO:
Obtenga los puntos de retiro disponibles seg煤n la direcci贸n proporcionada, incluyendo sucursales y lockers. Esta informaci贸n permite ofrecer a sus clientes opciones flexibles de entrega.
IMPRESI脫N DE ETIQUETAS:
Genere etiquetas de env铆o en diferentes formatos (A4, Z10X10, Z10X6, ZPL) seg煤n las necesidades de su operaci贸n log铆stica.
NORMALIZADOR DE DIRECCIONES:
Valide y normalice las direcciones ingresadas para garantizar una correcta log铆stica de entrega. El sistema retornar谩 los datos del domicilio correctos seg煤n nuestra base de datos.
CANALIZADOR POR C脫DIGO POSTAL:
Consulte la log铆stica disponible seg煤n el c贸digo postal de destino. El sistema retornar谩 las opciones de entrega disponibles para esa zona.
CONSULTA PESO Y MEDIDAS:
Obtenga el peso y las dimensiones del paquete detectado al ser procesado en nuestros centros de distribuci贸n.
En cada request con sus m茅todos GET, POST, se va a requerir la autenticaci贸n correspondiente al shipper, en el mismo se especificar谩 un password.
Consultar con Urbano Express por las credenciales correspondientes a su shipper.
Aclaraci贸n:
Los campos de autenticaci贸n son requeridos en todos los casos salvo en el m茅todo GET de impresi贸n de etiquetas.
El c贸digo postal es de 4 d铆gitos desde 1000 a 9999
La API est谩 disponible en dos ambientes:
Desarrollo/Testing:
https://testing-apis.urbano.com.ar/
Utilizado para pruebas y desarrollo del cliente. Las URLs en esta documentaci贸n apuntan a este ambiente.
Producci贸n:
https://apis.urbano.com.ar/
Utilizado para el procesamiento real de env铆os. Requiere credenciales de producci贸n.
Importante: Al pasar a producci贸n hay que cambiar las URL
https://testing-apis.urbano.com.ar/ por https://apis.urbano.com.ar/
Consulta de Tarifa
Nos retornar谩 la tarifa correspondiente seg煤n su c贸digo postal, adem谩s de devolvernos el "PesoReal". nos informara si existiera un error con su numero y con su descripci贸n.
POST https://testing-apis.urbano.com.ar/consulta_tarifa_rest/
Par谩metros:
| Requerido |
Parametro |
Tipo |
Longitud |
Descripci贸n |
|
codigoPostal |
integer |
4 |
C贸digo postal de destino |
|
pesoEspecifico |
decimal |
4,2 |
Peso del paquete en kg |
|
pesoVolumetrico |
decimal |
4,2 |
Peso volum茅trico del paquete en kg |
|
alto |
decimal |
4,2 |
Alto del paquete en cm |
|
largo |
decimal |
4,2 |
Largo del paquete en cm |
|
ancho |
decimal |
4,2 |
Ancho del paquete en cm |
|
shipper |
integer |
- |
N煤mero de shipper |
|
password |
string |
- |
Contrase帽a del shipper |
Tracking
Consulta el seguimiento seg煤n el par谩metro de "codigoSeguimiento", Nos retornara la URL del seguimiento, adem谩s de los movimientos con los par谩metros check, descripci贸n y fecha / hora.
POST https://testing-apis.urbano.com.ar/tracking/consultaTrackingMasivo/
Par谩metros:
| Requerido |
Parametro |
Tipo |
Longitud |
Descripci贸n |
|
codigoSeguimiento |
string |
4-15 |
C贸digo de seguimiento del env铆o |
|
shipper |
integer |
- |
N煤mero de shipper |
|
password |
string |
- |
Contrase帽a del shipper |
Estados devueltos de movimiento:
PI - PEDIDO INGRESADO
AS - DESPACHO SUCURSAL
LD - SALIDA A RUTA
DL - ENTREGA EFECTIVA
Carga de Clientes
Ingresamos un cliente como destinatario especificando su domicilio, adicionando como opcional un segundo domicilio, se deber谩 ingresar un numero de seguimiento, remito y observaciones. En Producto se ingresara la descripci贸n, sus medidas, longitud, peso, valor, sku y la cantidad.
POST https://testing-apis.urbano.com.ar/cargaCliente/
| Requerido |
Parametro |
Tipo |
Longitud |
Descripci贸n |
| productos (array) |
|
largo |
decimal |
4,2 |
Refiere al largo total del envio |
|
alto |
decimal |
4,2 |
Refiere al alto total del envio |
|
ancho |
decimal |
4,2 |
Refiere al ancho total del envio |
|
peso |
decimal |
4,2 |
Refiere al peso espec铆fico del envio |
|
valor |
integer |
8 |
Refiere al valor total de la compra para asegurar el producto |
|
valorContrareembolso |
integer |
8 |
Refiere al valor de pago (contra entrega) |
|
cantidad |
integer |
8 |
Refiere a la cantidad de etiquetas que se imprimiran en el pedido |
|
sku |
string |
30 |
Refiere al identificador SKU. |
|
descripcionProducto |
string |
40 |
Refiere a la descripcion del producto |
| autentificacion |
|
shipper |
integer |
- |
N煤mero de shipper |
|
password |
string |
- |
Contrase帽a del shipper |
| destinatario |
|
tipoDocumento |
string |
10 |
Refiere al tipo de identificaci贸n de la persona |
|
numeroDocumento |
integer |
10 |
Refiere al nro de documento de la persona |
|
nombre |
string |
40 |
Refiere al nombre de la persona |
|
email |
array/string |
45 |
Refiere al correo electr贸nico |
|
telefono |
string |
40 |
Refiere al tel茅fono particular |
|
celular |
string |
15 |
Refiere al celular |
| autorizado (array) - Ver campos de destinatario |
| domicilio |
|
direccion |
string |
45 |
Direcci贸n del destinatario |
|
altura |
string |
6 |
Numeraci贸n del domicilio |
|
piso |
string |
6 |
Piso del domicilio |
|
departamento |
string |
6 |
Departamento del domicilio |
|
codigoPostal |
integer |
4 |
C贸digo Postal |
|
localidad |
string |
- |
Localidad del domicilio |
|
provincia |
string |
- |
Provincia del domicilio |
|
latitud |
string |
10 |
Localizaci贸n en latitud |
|
longitud |
string |
10 |
Localizaci贸n en longitud |
|
telefono |
array |
- |
Tel茅fono del domicilio (array) |
| domicilioAlternativo - Ver campos de domicilio (todos opcionales) |
| Ra铆z |
|
datoNumerico |
string |
10 |
Dato num茅rico adicional |
|
codigoSeguimiento |
string |
4-15 |
C贸digo 煤nico identificador del env铆o (m铆nimo 4, m谩ximo 15 caracteres) |
|
codigoAlternativo |
integer |
15 |
C贸digo alternativo |
|
servicio |
string |
1 |
Tipo de servicio |
|
observaciones |
array |
2 |
Observaciones adicionales (2 elementos de 95 caracteres) |
- Tipos de servicio:
- E: Entrega
- R: Retiro
- B: Contra reembolso
- F: Retiro en sucursal
- G: Retiro en sucursal contra reembolso
- Si el servicio es de contrareembolso el importe del reembolso no puede estar en 0
- Si el cliente tiene seguro el precio del producto no puede estar en 0
- Campos del destinatario son obligatorios salvo tel茅fono y mail que pueden ser nulos.
- Campos receptor autorizado pueden ser nulos
- Campos del apartado domicilio: altura, piso, departamento, longitud, latitud pueden ser nulos. La direcci贸n, localidad, provincia y el c贸digo postal son obligatorios.
- Campos del domicilio alternativo pueden ser nulos.
- El c贸digo de seguimiento es obligatorio y tiene un m谩ximo de 15 caracteres (m铆nimo 4).
- C贸digo de seguimiento alternativo puede ser nulo.
- Observaciones pueden ser nulos. El l铆mite de caracteres es de 95 caracteres, m谩ximo 2 observaciones.
- Si el Pedido es con retiro en sucursal debemos especificar el c贸digo de sucursal en la "localidad". Por ejemplo:
G23.
WAREHOUSING:
- El c贸digo SKU no puede ser nulo
- El peso del producto puede estar en 0
CROSS:
- El peso del producto (bulto) no puede estar en 0
Puntos de Retiro
Ingresando seg煤n nuestra direcci贸n, nos retornara todos los puntos de retiro disponibles incluyendo seg煤n su ciudad y los par谩metros correspondientes de "latitud", "longitud", "nombre", "direcci贸n", "tel茅fono", "c贸digo", "entrecalles", "codigoPostal", "municipalidad", "localidad", "provincia", "elockers", "distancia".
POST https://testing-apis.urbano.com.ar/puntosDeRetiroRest/
Par谩metros:
| Requerido |
Parametro |
Tipo |
Longitud |
Descripci贸n |
|
direccion |
string |
45 |
Direcci贸n a buscar |
|
altura |
string |
6 |
Altura de la direcci贸n |
|
codigoPostal |
integer |
4 |
C贸digo postal de la direcci贸n |
|
longitud |
string |
10 |
Longitud geogr谩fica de la direcci贸n |
|
latitud |
string |
10 |
Latitud geogr谩fica de la direcci贸n |
|
elockers |
integer |
1 |
Filtrar por e-lockers (0 o 1) |
|
shipper |
integer |
- |
N煤mero de shipper |
|
password |
string |
- |
Contrase帽a del shipper |
Puntos de Retiro Sucursales
Ingresando ubicacion, pieza y autentificacion.
POST https://testing-apis.urbano.com.ar/puntosDeRetiroSucursales/
Par谩metros:
| Requerido |
Parametro |
Tipo |
Longitud |
Descripci贸n |
|
va_prov_codigo |
string |
2 |
Siempre poner "%" para obtener todas las opciones |
|
va_con_llc |
integer |
1 |
Con locker (1) o sin locker (0) |
|
peso |
decimal |
4,2 |
Peso de la pieza |
|
alto |
decimal |
4,2 |
Altura de la pieza |
|
largo |
decimal |
4,2 |
Largo de la pieza |
|
ancho |
decimal |
4,2 |
Ancho de la pieza |
|
shipper |
integer |
- |
N煤mero de shipper |
|
password |
string |
- |
Contrase帽a del shipper |
Canalizador por C贸digo Postal
Ingresando seg煤n nuestro c贸digo postal, nos retornara la log铆stica seg煤n su c贸digo, nos informara si la consulta a sido completada, adem谩s de informarnos sobre alg煤n error en la base de datos con el c贸digo de error.
POST https://testing-apis.urbano.com.ar/canalizadorPorCodigoPostalRest/
Par谩metros:
| Requerido |
Parametro |
Tipo |
Longitud |
Descripci贸n |
|
codigoPostal |
integer |
4 |
C贸digo postal a consultar |
|
sameday |
integer |
1 |
0: Deshabilitado en el mismo d铆a, 1: Habilitado en el mismo d铆a |
|
shipper |
integer |
- |
N煤mero de shipper |
|
password |
string |
- |
Contrase帽a del shipper |
Impresi贸n de Etiquetas
Enviando el c贸digo de seguimiento y el tipo de formato a imprimir nos devuelve el PDF correspondiente.
GET https://testing-apis.urbano.com.ar/impresionEtiqueta/?tipo={tipo}&shipper={shipper}&codSeguimiento={codigoSeguimiento}
Par谩metros:
| Requerido |
Parametro |
Tipo |
Longitud |
Descripci贸n |
|
tipo |
string |
10 |
Formato de gu铆a para imprimir (A4, Z10X10, Z10X6, ZPL) |
|
shipper |
integer |
- |
N煤mero de shipper |
|
codigoSeguimiento |
string |
4-15 |
C贸digo de seguimiento del paquete |
Nota: Este endpoint no requiere autenticaci贸n
Normalizador de Direcciones
Ingresando seg煤n nuestra direcci贸n, nos retornara los datos del domicilio correctos de acuerdo a nuestras bases, de esta manera obtendremos mayor agilidad en la log铆stica de los env铆os.
POST https://testing-apis.urbano.com.ar/normalizadorDireccionRest/
Par谩metros:
| Requerido |
Parametro |
Tipo |
Longitud |
Descripci贸n |
|
calle |
string |
45 |
Calle a consultar |
|
altura |
string |
6 |
Altura a consultar |
|
cp |
integer |
4 |
C贸digo postal a consultar |
|
localidad |
string |
- |
Localidad a consultar |
|
provincia |
string |
- |
Provincia a consultar |
|
shipper |
integer |
- |
N煤mero de shipper |
|
password |
string |
- |
Contrase帽a del shipper |
Consulta peso y medidas
Ingresando el c贸digo de seguimiento, nos retornar谩 el peso y medidas del paquete detectado al ser procesados.
POST https://testing-apis.urbano.com.ar/consultaPesoMedidas/
Par谩metros:
| Requerido |
Parametro |
Tipo |
Longitud |
Descripci贸n |
|
codigoSeguimiento |
string |
4-15 |
C贸digo de seguimiento para la b煤squeda |
|
shipper |
integer |
- |
N煤mero de shipper |
|
password |
string |
- |
Contrase帽a del shipper |
| codError |
descError |
resultado |
| 0 |
resultado |
CONSULTA EXITOSA |
| 1 |
No se han enviado datos para la autentificaci贸n de usuario. |
ERROR |
| 2 |
Faltan campos necesarios. |
ERROR |
| 3 |
Ha sucedido un error interno al procesar el servicio. |
ERROR |
| 4 |
Ha sucedido un error interno al procesar el servicio. |
ERROR |
| 5 |
C贸digo Postal Inv谩lido. |
ERROR |
- codError: El tipo de dato es "Integer". En caso de que hubiera un error, el n煤mero correspondiente a dicho error.
- descError: El tipo de dato es "String". En caso de que hubiera un error, la descripci贸n correspondiente a dicho error.
- resultado: El tipo de dato es "String". En caso de que hubiera un error, retornara ERROR.
Buenas Practicas
Recomendaciones:
- Validar datos: Siempre valide los datos antes de enviarlos a la API.
- Manejo de errores: Implemente un adecuado manejo de errores y reintentos.
- Caching: Para consultas de tarifas frecuentes, considere implementar caching.
- Logging: Mantenga un registro de las solicitudes y respuestas para facilitar el diagn贸stico.
- Rate limiting: Respete los l铆mites de tasa de la API para evitar bloqueos.