Guia de referencia del API

El API de Globalpaq es un servicio REST que te permite realizar una rango de tareas relacionadas con nuestro plataforma:

  • Consultar Asignaciones
  • Consultar Historial de guias
  • Consular Guias Disponibles
  • Consultar Cobertura
  • Consular Rastreo
  • Generar Guias

Las peticiones se deben hacer a la suiguiente direccion:

https://sistema.globalpaq.mx/api/v2/public/


Autenticación

Para hacer uso del API es necesario contar con una clave ligada al usuario registrado en nuestra plataforma. La clave se genera en la seccion "Globalpaq API" solo se permite una clave por usuario.
El formato de la lla ve generada es la siguiente:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjA5NTg2MjksImV4cCI6MTU5MjQ5NDYyOSwiZGF0YSI6eyJpZCI
La clave debe enviarse mediante la cabezera Authorization Ejemplo:
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjA5NTg2MjksImV4cCI6MTU5MjQ5NDYyOSwiZGF0YSI6eyJpZCI

Cuando no se envia la cabezera con la clave requerida el API regresa un mensaje informando el error:

                {
                    "error": true,
                    "status": 403,
                    "message": "Se requiere un Token"
                }
                        

Si se envia una clave no valida se informa mediante el siguiente mensaje:

                {
                    "error": true,
                    "status": 403,
                    "message": "Token Invalido"
                }
                        

Se puede dar el caso de que se envie una clave correcta pero por otros motivos el usuario se encuentre bloqueado para hacer uso de nuestra plataforma.

                {
                    "error": true,
                    "status": 403,
                    "message": "Usuario Inactivo"
                }
                        


FEDEX

Las peticiones a las tareas relacionadas con Fedex deben contener en la ruta fedex/ seguido de la accion a realizar.


GET Asignaciones

Regresa una lista de todas las asignacones de guias.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/fedex/asignaciones

GET Historial

Regresa una lista de todas las guias generadas.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/fedex/historial

GET Disponibles

Regresa una lista del tipo, peso y cantidad de guias disponibles para generar.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/fedex/disponibles

GET Cobertura

Se deben enviar como parametros en la URL el codigo postal origen y el codigo postal destino.

Regresa los servicios disponibles por fedex y si genera zona extendida

Ruta:

https://sistema.globalpaq.mx/api/v2/public/fedex/cobertura

Parametros:

Parametro Descripcion Obligatorio
cp_origen Codigo Postal de origen Numerico 5 caracteres
cp_distino Codigo Postal de destino Numerico 5 caracteres

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/fedex/cobertura?cp_origen=54435&cp_destino=95085

GET Rastreo

Se deben enviar como parametros en la ruta el numero de guia valido.

Regresa la informacion de rastreo de la guia

Ruta:

https://sistema.globalpaq.mx/api/v2/public/fedex/tracking

Parametros:

Parametro Descripcion Obligatorio
tracking Numero de la guia Numerico

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/fedex/tracking/787841583286

POST Guia

Genera una guia fedex

Se deben enviar como parametros post los datos necesarios para la generacion de la guia

Regresa el numero de guia y nombre del archivo PDF generado

Ruta:

https://sistema.globalpaq.mx/api/v2/public/fedex/guia

Parametros:

Parametro Descripcion Obligatorio max. caracteres
guia_tipo Tipo de guia, ver tipos disponibles en (fedex/disponibles)
guia_peso Peso de guia, ver tipos disponibles en (fedex/disponibles)
guia_tipo_papel Tipo papel 0 Media carta default, 1 Tamaño termico
guia_rec Si la guia tendra recoleccion (por el monento esta funcion no esta disponible)
shipper_nombre Nombre del remitente 29
shipper_compania Nombre del negocio del remitente 35
shipper_telefono Telefono de contacto del remitente
shipper_calle Calle del remitente 35
shipper_calle2 Calle del remitente 35
shipper_ciudad Ciudad del remitente 35
recipient_estado Estado del remitente
shipper_cp Codigo Postal del remitente 5
recipient_nombre Nombre del destinatario 29
recipient_compania Compañia del destinatario 35
recipient_telefono Telefono del destinatario
recipient_calle Calle del destinatario 35
recipient_calle2 Calle del destinatario 35
recipient_ciudad Ciudad del destinatario 35
recipient_estado Estado del destinatario
recipient_cp Codigo postal del destinatario 5
packageLineItem_valor Valor del paquete en caso de querer asegurar y tener disponible el permiso
packageLineItem_peso Peso declarado del paquete
packageLineItem_largo Largo del paquete
packageLineItem_ancho Ancho del paquete
packageLineItem_alto Largo del paquete

Ejemplo:

                guia_tipo:10
                guia_peso:5
                guia_tipo_papel:1
                guia_rec:no
                shipper_nombre:Globalpaq
                shipper_compania:Globalpaq
                shipper_telefono:5521688202
                shipper_calle:Fraccionamiento Ciudad Campestre 
                shipper_calle2:And. 20 Lt 9 Mzn. 3
                shipper_ciudad:Nicolas romero
                shipper_estado:MEX
                shipper_cp:54435
                recipient_nombre:Elizabeth
                recipient_compania:Seven
                recipient_telefono:5521687121
                recipient_calle:Calle 22 de mayo
                recipient_calle2:esquina con circular
                recipient_ciudad:Nicolas Romero
                recipient_estado:MEX
                recipient_cp:54400
                packageLineItem_valor:10
                packageLineItem_peso:5
                packageLineItem_largo:5
                packageLineItem_ancho:5
                packageLineItem_alto:5
                                            

GET Guia

Regresa la ruta del pdf de la guia correspondiente al tracking proporcionado.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/fedex/guia

Parametros:

Parametro Descripcion Obligatorio
tracking Numero de la guia Numerico

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/fedex/guia/787991798487

GET Cancelar

Cancela una guia generada Consultar requerimentos para poder cancelar con su acesor.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/fedex/cancelar

Parametros:

Parametro Descripcion Obligatorio
tracking Numero de la guia Numerico

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/fedex/cancelar/787991798487

POST Recoleccion

Genera la recoleccion de una guia Consultar requerimentos para poder generar recolecciones con su acesor.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/fedex/recoleccion

Parametros:

Parametro Descripcion Obligatorio
shipper_nombre Nombre del remitente
shipper_compania Compañia del remitente
shipper_telefono Telefono del remitente
shipper_calle calle del remitente
shipper_colonia colonia del remitente
shipper_ciudad ciudad del remitente
shipper_estado estado del remitente
shipper_cp codigo postal del remitente
shipper_instructions instrucciones especiales
packageLineItem_peso peso del paquete
packageLineItem_largo largo del paquete
packageLineItem_ancho ancho del paquete
packageLineItem_alto alto del paquete
date_pickup fecha de la recoleccion
package_time_ready hora en el que el paquete estara listo
last_available_hour ultima hora en la que puede pasar recoleccion
tracking numero de guia a la cual generar la recoleccion

Ejemplo:

                        shipper_nombre:Juan Jose Jorge
                        shipper_compania:Globalpaq
                        shipper_telefono:5525222989
                        shipper_calle:Fraccionamiento Ciudad Campestre, Andador 20, Casa 9 Manzana 3
                        shipper_colonia:22 de febrero
                        shipper_ciudad:Nicolas romero
                        shipper_estado:MEX
                        shipper_cp:54435
                        shipper_instructions:Casa esquinera
                        packageLineItem_peso:5
                        packageLineItem_largo:10
                        packageLineItem_ancho:10
                        packageLineItem_alto:10
                        date_pickup:2019-12-28
                        package_time_ready:12:00:00
                        last_available_hour:18:00:00
                        tracking:779203417633
                                            

DHL

Las peticiones a las tareas relacionadas con DHL deben contener en la ruta dhl/ seguido de la accion a realizar.


GET Asignaciones

Regresa una lista de todas las asignacones de guias.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/dhl/asignaciones

GET Historial

Regresa una lista de todas las guias generadas.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/dhl/historial

GET Disponibles

Regresa una lista del tipo, peso y cantidad de guias disponibles para generar.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/dhl/disponibles

GET Rastreo

Se deben enviar como parametros en la ruta el numero de guia valido.

Regresa la informacion de rastreo de la guia

Ruta:

https://sistema.globalpaq.mx/api/v2/public/dhl/tracking

Parametros:

Parametro Descripcion Obligatorio
tracking Numero de la guia Numerico

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/dhl/tracking/5990250280

POST Guia

Genera una guia dhl

Se deben enviar como parametros post los datos necesarios para la generacion de la guia

Regresa el numero de guia y nombre del archivo PDF generado

Ruta:

https://sistema.globalpaq.mx/api/v2/public/dhl/guia

Parametros:

Parametro Descripcion Obligatorio max. caracteres
guia_tipo Tipo de guia, ver tipos disponibles en (dhl/disponibles)
guia_peso Peso de guia, ver tipos disponibles en (dhl/disponibles)
guia_rec Si la guia tendra recoleccion (por el monento esta funcion no esta disponible)
shipper_nombre Nombre del remitente 29
shipper_compania Nombre del negocio del remitente 35
shipper_telefono Telefono de contacto del remitente
shipper_calle Calle del remitente 35
shipper_calle2 Calle del remitente 35
shipper_ciudad Ciudad del remitente 35
shipper_estado Estado del remitente
shipper_cp Codigo Postal del remitente 5
recipient_nombre Nombre del destinatario 29
recipient_compania Compañia del destinatario 35
recipient_telefono Telefono del destinatario
recipient_calle Calle del destinatario 35
recipient_calle2 Calle del destinatario 35
recipient_ciudad Ciudad del destinatario 35
recipient_estado Estado del destinatario
recipient_cp Codigo postal del destinatario 5
packageLineItem_valor Valor del paquete en caso de querer asegurar y tener disponible el permiso
packageLineItem_peso Peso declarado del paquete
packageLineItem_largo Largo del paquete
packageLineItem_ancho Ancho del paquete
packageLineItem_alto Largo del paquete
packageLineItem_contenido Contenido del paquete

Ejemplo:

                    guia_tipo:20
                    guia_peso:5
                    guia_rec:no
                    shipper_nombre:Globalpaq
                    shipper_compania:Globalpaq
                    shipper_telefono:5521688202
                    shipper_calle:Av. Fraccionamiento Ciudad Campestre 
                    shipper_calle2:And. 20 Lt 9 Mzn. 3
                    shipper_ciudad:Nicolas romero
                    shipper_estado:MEX
                    shipper_cp:54435
                    recipient_nombre:Elizabeth
                    recipient_compania:Seven
                    recipient_telefono:5558234219
                    recipient_calle:Calle 22 de mayo
                    recipient_calle2:esquina con circular
                    recipient_ciudad:Nicolas Romero
                    recipient_estado:MEX
                    recipient_cp:54400
                    packageLineItem_peso:5
                    packageLineItem_largo:10
                    packageLineItem_ancho:10
                    packageLineItem_alto:10
                    packageLineItem_contenido:Prueba
                                            

GET Cobertura

Se deben enviar como parametros en la URL el codigo postal origen y el codigo postal destino.

Regresa un mensaje indicando si los codigos postales generan cobertura extendida.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/dhl/cobertura

Parametros:

Parametro Descripcion Obligatorio
cp_origen Codigo Postal de origen Numerico 5 caracteres
cp_distino Codigo Postal de destino Numerico 5 caracteres

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/dhl/cobertura?cp_origen=54435&cp_destino=95085

GET Guia

Regresa la ruta del pdf de la guia correspondiente al tracking proporcionado.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/dhl/guia

Parametros:

Parametro Descripcion Obligatorio
tracking Numero de la guia Numerico

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/dhl/guia/4922991776

GET Cancelar

Cancela una guia generada Consultar requerimentos para poder cancelar con su acesor.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/dhl/cancelar

Parametros:

Parametro Descripcion Obligatorio
tracking Numero de la guia Numerico

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/dhl/cancelar/591798487

POST Recoleccion

Genera la recoleccion de una guia Consultar requerimentos para poder generar recolecciones con su acesor.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/dhl/recoleccion

Parametros:

Parametro Descripcion Obligatorio
shipper_nombre Nombre del remitente
shipper_compania Compañia del remitente
shipper_telefono Telefono del remitente
shipper_calle calle del remitente
shipper_colonia colonia del remitente
shipper_ciudad ciudad del remitente
shipper_estado estado del remitente
shipper_cp codigo postal del remitente
shipper_instructions instrucciones especiales
packageLineItem_peso peso del paquete
packageLineItem_largo largo del paquete
packageLineItem_ancho ancho del paquete
packageLineItem_alto alto del paquete
date_pickup fecha de la recoleccion
package_time_ready hora en el que el paquete estara listo
last_available_hour ultima hora en la que puede pasar recoleccion
tracking numero de guia a la cual generar la recoleccion

Ejemplo:

                        shipper_nombre:Juan Jose Jorge
                        shipper_compania:Globalpaq
                        shipper_telefono:5525222989
                        shipper_calle:Fraccionamiento Ciudad Campestre, Andador 20, Casa 9 Manzana 3
                        shipper_colonia:22 de febrero
                        shipper_ciudad:Nicolas romero
                        shipper_estado:MEX
                        shipper_cp:54435
                        shipper_instructions:Casa esquinera
                        packageLineItem_peso:5
                        packageLineItem_largo:10
                        packageLineItem_ancho:10
                        packageLineItem_alto:10
                        date_pickup:2019-12-28
                        package_time_ready:12:00:00
                        last_available_hour:18:00:00
                        tracking:779203417633
                                            

ESTAFETA

Las peticiones a las tareas relacionadas con ESTAFETA deben contener en la ruta estafeta/ seguido de la accion a realizar.


GET Asignaciones

Regresa una lista de todas las asignacones de guias.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/estafeta/asignaciones

GET Historial

Regresa una lista de todas las guias generadas.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/estafeta/historial

GET Disponibles

Regresa una lista del tipo, peso y cantidad de guias disponibles para generar.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/estafeta/disponibles

GET Rastreo

Se deben enviar como parametros en la ruta el numero de guia valido.

Regresa la informacion de rastreo de la guia

Ruta:

https://sistema.globalpaq.mx/api/v2/public/estafeta/tracking

Parametros:

Parametro Descripcion Obligatorio
tracking Numero de la guia Numerico

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/estafeta/tracking/8050000000130700449234

POST Guia

Genera una guia Estafeta

Se deben enviar como parametros post los datos necesarios para la generacion de la guia

Regresa el numero de guia y nombre del archivo PDF generado

Ruta:

https://sistema.globalpaq.mx/api/v2/public/estafeta/guia

Parametros:

Parametro Descripcion Obligatorio
guia_tipo Tipo de guia, ver tipos disponibles en (estafeta/disponibles)
guia_peso Peso de guia, ver tipos disponibles en (estafeta/disponibles)
guia_rec Si la guia tendra recoleccion (por el monento esta funcion no esta disponible)
shipper_nombre Nombre del remitente
shipper_compania Nombre del negocio del remitente
shipper_telefono Telefono de contacto del remitente
shipper_calle Calle del remitente
shipper_calle2 Calle del remitente
shipper_ciudad Ciudad del remitente
recipient_estado Estado del remitente
shipper_cp Codigo Postal del remitente
recipient_nombre Nombre del destinatario
recipient_compania Compañia del destinatario
recipient_telefono Telefono del destinatario
recipient_calle Calle del destinatario
recipient_calle2 Calle del destinatario
recipient_ciudad Ciudad del destinatario
recipient_estado Estado del destinatario
recipient_cp Codigo postal del destinatario
packageLineItem_valor Valor del paquete en caso de querer asegurar y tener disponible el permiso
packageLineItem_peso Peso declarado del paquete
packageLineItem_largo Largo del paquete
packageLineItem_ancho Ancho del paquete
packageLineItem_alto Largo del paquete
packageLineItem_contenido Contenido del paquete

Ejemplo:

                guia_tipo:25
                guia_peso:5
                guia_rec:no
                shipper_nombre:Globalpaq
                shipper_compania:Globalpaq
                shipper_telefono:5521688202
                shipper_calle:Fraccionamiento Ciudad Campestre
                shipper_calle2:And. 20 Lt 9 Mzn. 3
                shipper_ciudad:Nicolas romero
                shipper_estado:MEX
                shipper_cp:54435
                recipient_nombre:Elizabeth
                recipient_compania:Seven
                recipient_telefono:5521687121
                recipient_calle:Calle 22 de mayo
                recipient_calle2:esquina con circular
                recipient_ciudad:Nicolas Romero
                recipient_estado:MEX
                recipient_cp:54400
                packageLineItem_peso:5
                packageLineItem_largo:10
                packageLineItem_ancho:10
                packageLineItem_alto:10
                packageLineItem_contenido:Prueba
                                        

GET Guia

Regresa la ruta del pdf de la guia correspondiente al tracking proporcionado.

Ruta:

https://sistema.globalpaq.mx/api/v2/public/estafeta/guia

Parametros:

Parametro Descripcion Obligatorio
tracking Numero de la guia Numerico

Ejemplo:

https://sistema.globalpaq.mx/api/v2/public/estafeta/guia/8050000000130700449234
b