Guía de referencia del API
El API de Globalpaq es un servicio REST que te permite realizar un rango de tareas relacionadas con nuestra plataforma:
- Consultar Historial de Guías
- Consultar Guías Disponibles
- Consultar Cobertura
- Consultar Rastreo
- Generar Guías
Las peticiones se deben hacer a la siguiente dirección:
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 sección "Globalpaq API" solo se permite una clave por usuario.
El formato de la llave generada es la siguiente:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjA5NTg2MjksImV4cCI6MTU5MjQ5NDYyOSwiZGF0YSI6eyJpZCI
La clave debe enviarse mediante la cabecera Authorization Ejemplo:
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjA5NTg2MjksImV4cCI6MTU5MjQ5NDYyOSwiZGF0YSI6eyJpZCI
Cuando no se envía la cabecera con la clave requerida el API regresa un mensaje informando el error:
{
"error": true,
"status": 403,
"message": "Se requiere un Token"
}
Si se envía 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 envíe 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 acción a realizar.
GET Historial
Regresa una lista de todas las guías generadas.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/fedex/historial
GET Disponibles
Regresa una lista del tipo, peso y cantidad de guías disponibles para generar.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/fedex/disponibles
GET Cobertura
Se deben enviar como parámetros en la URL el código postal origen y el código postal destino.
Regresa los servicios disponibles por FedEx y si genera zona extendida
Ruta:
https://sistema.globalpaq.mx/api/v2/public/fedex/cobertura
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
cp_origen |
Código Postal de origen |
Numérico 5 caracteres |
|
cp_distino |
Código Postal de destino |
Numérico 5 caracteres |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/fedex/cobertura?cp_origen=54435&cp_destino=95085
GET Rastreo
Se deben enviar como parámetros en la ruta el número de guía valido.
Regresa la información de rastreo de la guía
Ruta:
https://sistema.globalpaq.mx/api/v2/public/fedex/tracking
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/fedex/tracking/787841583286
POST Guía
Genera una guía FedEx
Se deben enviar como parámetros post los datos necesarios para la generación de la guía
Regresa el número de guía y nombre del archivo PDF generado
Ruta:
https://sistema.globalpaq.mx/api/v2/public/fedex/guia
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
max. caracteres |
guia_tipo |
Tipo de guía, ver tipos disponibles en (fedex/disponibles) |
|
|
|
guia_peso |
Peso de guía, ver tipos disponibles en (fedex/disponibles) |
|
|
|
guia_tipo_papel |
Tipo papel 0 Media carta default, 1 Tamaño térmico |
|
|
|
guia_rec |
Si la guía tendrá recolección (por el momento esta función no está disponible) |
|
|
|
shipper_nombre |
Nombre del remitente |
|
|
29 |
shipper_compania |
Nombre del negocio del remitente |
|
|
35 |
shipper_telefono |
Teléfono 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 |
Código Postal del remitente |
|
|
5 |
recipient_nombre |
Nombre del destinatario |
|
|
29 |
recipient_compania |
Compañía del destinatario |
|
|
35 |
recipient_telefono |
Teléfono 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 |
Código 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 |
|
|
|
valor_mercancia |
Valor del paquete |
|
|
|
shipper_rfc |
R.F.C. del remitente |
|
|
|
recipient_rfc |
R.F.C. del destinatario |
|
|
|
cp_numeroMercancias |
Número total de Mercancías dentro del paquete * |
|
|
|
cp_descripcion |
Descripción Mercancías transportadas * |
|
|
|
cp_cantidad |
Cantidad total de artículos dentro del paquete * |
|
|
|
cp_peso |
Peso total del paquete (en kilos) * |
|
|
|
cp_c_ClaveProdServ |
Clave productos transportados (SAT - Catálogo de productos Carta Porte.- c_ClaveProdServCP) * |
|
|
|
cp_c_ClaveUnidadPeso |
Clave Unidad de peso (SAT - Catálogo de unidades de medida y embalaje Carta Porte.- c_ClaveUnidadPeso) * |
|
|
|
pagarSaldoPrepago |
'on/NO' En el caso de querer cubir la operación con saldo prepago / O con guias disponibles |
|
|
|
* Carta Porte Nota:
En la página del SAT encontrara "Complemento Carta Porte" donde están los catálogos requeridos en
http://omawww.sat.gob.mx/tramitesyservicios/Paginas/complemento_carta_porte.htm
Catálogos del complemento.
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
valor_mercancia:100
shipper_rfc:XAXX010101000
recipient_rfc:XAXX010101000
cp_numeroMercancias:1
cp_descripcion:Playeras
cp_cantidad:1
cp_peso:1
cp_c_ClaveProdServ:53101602
cp_c_ClaveUnidadPeso:KGM
pagarSaldoPrepago:on
GET Guía
Regresa la ruta del pdf de la guía correspondiente al tracking proporcionado.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/fedex/guia
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/fedex/guia/787991798487
GET Cancelar
Cancela una guía generada Consultar requerimientos para poder cancelar con su
asesor.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/fedex/cancelar
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/fedex/cancelar/787991798487
POST Recolección
Genera la recolección de una guía Consultar requerimientos para poder generar recolecciones
con su asesor.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/fedex/recoleccion
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
shipper_nombre |
Nombre del remitente |
|
|
shipper_compania |
Compañía del remitente |
|
|
shipper_telefono |
Teléfono del remitente |
|
|
shipper_calle |
calle del remitente |
|
|
shipper_colonia |
colonia del remitente |
|
|
shipper_ciudad |
ciudad del remitente |
|
|
shipper_estado |
estado del remitente |
|
|
shipper_cp |
código 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 |
|
|
valor_mercancia |
Valor del paquete |
|
|
|
date_pickup |
fecha de la recolección |
|
|
package_time_ready |
hora en el que el paquete estará listo |
|
|
last_available_hour |
ultima hora en la que puede pasar recolección |
|
|
tracking |
número de guía a la cual generar la recolección |
|
|
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
valor_mercancia:100
date_pickup:2019-12-28
package_time_ready:12:00:00
last_available_hour:18:00:00
tracking:779203417633
POSTZona lejana
Cobertura con zona lejana FedEx
Se deben enviar como parámetros post los datos necesarios para la verificar cobertura y costo zona lejana
Regresa los servicios disponibles por FedEx, si genera zona extendida y costo zona lejana
Ruta:
https://sistema.globalpaq.mx/api/v2/public/fedex/coberturaconzona
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
guia_tipo |
Tipo de guía, ver tipos disponibles en (fedex/disponibles) |
|
|
|
guia_peso |
Peso de guía, ver tipos disponibles en (fedex/disponibles) |
|
|
|
cp_origen |
Código Postal de origen |
Numérico 5 caracteres |
|
cp_destino |
Código Postal de destino |
Numérico 5 caracteres |
|
DHL
Las peticiones a las tareas relacionadas con DHL deben contener en la ruta dhl/ seguido de la acción a realizar.
GET Historial
Regresa una lista de todas las guías generadas.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/dhl/historial
GET Disponibles
Regresa una lista del tipo, peso y cantidad de guías disponibles para generar.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/dhl/disponibles
GET Rastreo
Se deben enviar como parámetros en la ruta el número de guía valido.
Regresa la información de rastreo de la guía
Ruta:
https://sistema.globalpaq.mx/api/v2/public/dhl/tracking
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/dhl/tracking/5990250280
POST Guía
Genera una guía DHL
Se deben enviar como parámetros post los datos necesarios para la generación de la guía
Regresa el número de guía y nombre del archivo PDF generado
Ruta:
https://sistema.globalpaq.mx/api/v2/public/dhl/guia
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
max. caracteres |
guia_tipo |
Tipo de guía, ver tipos disponibles en (dhl/disponibles) |
|
|
|
guia_peso |
Peso de guía, ver tipos disponibles en (dhl/disponibles) |
|
|
|
guia_rec |
Si la guía tendrá recolección (por el momento esta función no está disponible) |
|
|
|
shipper_nombre |
Nombre del remitente |
|
|
29 |
shipper_compania |
Nombre del negocio del remitente |
|
|
35 |
shipper_telefono |
Teléfono de contacto del remitente |
|
|
|
EmailDHLRem |
Correo electronico 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 |
Código Postal del remitente |
|
|
5 |
recipient_nombre |
Nombre del destinatario |
|
|
29 |
recipient_compania |
Compañía del destinatario |
|
|
35 |
recipient_telefono |
Teléfono del destinatario |
|
|
|
EmailDHLDest |
Correo electronico de contacto 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 |
Código 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 |
|
|
|
valor_mercancia |
Valor del paquete |
|
|
|
packageLineItem_contenido |
Contenido del paquete |
|
|
|
shipper_rfc |
R.F.C. del remitente |
|
|
|
recipient_rfc |
R.F.C. del destinatario |
|
|
|
pagarSaldoPrepago |
'on/NO' En el caso de querer cubir la operación con saldo prepago / O con guias disponibles |
|
|
|
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
valor_mercancia:100
packageLineItem_contenido:Prueba
shipper_rfc:XAXX010101000
recipient_rfc:XAXX010101000
pagarSaldoPrepago:on
EmailDHLRem:prueba@globalpaq.com
EmailDHLDest:prueba@globalpaq.com
GET Cobertura
Se deben enviar como parámetros en la URL el código postal origen y el código postal destino.
Regresa un mensaje indicando si los códigos postales generan cobertura extendida.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/dhl/cobertura
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
cp_origen |
Código Postal de origen |
Numérico 5 caracteres |
|
cp_distino |
Código Postal de destino |
Numérico 5 caracteres |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/dhl/cobertura?cp_origen=54435&cp_destino=95085
GET Guía
Regresa la ruta del pdf de la guía correspondiente al tracking proporcionado.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/dhl/guia
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/dhl/guia/4922991776
GET Cancelar
Cancela una guía generada Consultar requerimientos para poder cancelar con su
asesor.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/dhl/cancelar
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/dhl/cancelar/591798487
POST Recolección
Genera la recolección de una guía Consultar requerimientos para poder generar recolecciones
con su asesor.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/dhl/recoleccion
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
shipper_nombre |
Nombre del remitente |
|
|
shipper_compania |
Compañía del remitente |
|
|
shipper_telefono |
Teléfono del remitente |
|
|
shipper_calle |
calle del remitente |
|
|
shipper_colonia |
colonia del remitente |
|
|
shipper_ciudad |
ciudad del remitente |
|
|
shipper_estado |
estado del remitente |
|
|
shipper_cp |
código 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 |
|
|
valor_mercancia |
Valor del paquete |
|
|
|
date_pickup |
fecha de la recolección |
|
|
package_time_ready |
hora en el que el paquete estará listo |
|
|
last_available_hour |
ultima hora en la que puede pasar recolección |
|
|
tracking |
número de guía a la cual generar la recolección |
|
|
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
valor_mercancia:100
date_pickup:2019-12-28
package_time_ready:12:00:00
last_available_hour:18:00:00
tracking:779203417633
POSTZona lejana
Cobertura con zona lejana DHL
Se deben enviar como parámetros post los datos necesarios para la verificar cobertura y costo zona lejana
Regresa si genera zona extendida y costo zona lejana
Ruta:
https://sistema.globalpaq.mx/api/v2/public/dhl/coberturaconzona
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
guia_tipo |
Tipo de guía, ver tipos disponibles en (dhl/disponibles) |
|
|
|
guia_peso |
Peso de guía, ver tipos disponibles en (dhl/disponibles) |
|
|
|
cp_origen |
Código Postal de origen |
Numérico 5 caracteres |
|
cp_destino |
Código Postal de destino |
Numérico 5 caracteres |
|
ESTAFETA
Las peticiones a las tareas relacionadas con ESTAFETA deben contener en la ruta
estafeta/ seguido de la acción a realizar.
GET Historial
Regresa una lista de todas las guías generadas.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/estafeta/historial
GET Disponibles
Regresa una lista del tipo, peso y cantidad de guías disponibles para generar.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/estafeta/disponibles
GET Rastreo
Se deben enviar como parámetros en la ruta el número de guía valido.
Regresa la información de rastreo de la guía
Ruta:
https://sistema.globalpaq.mx/api/v2/public/estafeta/tracking
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/estafeta/tracking/8050000000130700449234
POST Guía
Genera una guía Estafeta
Se deben enviar como parámetros post los datos necesarios para la generación de la guía
Regresa el número de guía y nombre del archivo PDF generado
Ruta:
https://sistema.globalpaq.mx/api/v2/public/estafeta/guia
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
guia_tipo |
Tipo de guía, ver tipos disponibles en (estafeta/disponibles) |
|
|
guia_peso |
Peso de guía, ver tipos disponibles en (estafeta/disponibles) |
|
|
guia_tipo_papel |
Tipo papel 0 Media carta default, 1 Tamaño térmico |
|
|
guia_rec |
Si la guía tendrá recolección (por el momento esta función no está disponible) |
|
|
shipper_nombre |
Nombre del remitente |
|
|
shipper_compania |
Nombre del negocio del remitente |
|
|
shipper_telefono |
Teléfono de contacto del remitente |
|
|
shipper_calle |
Calle del remitente |
|
|
shipper_calle2 |
Calle del remitente |
|
|
shipper_ciudad |
Ciudad del remitente |
|
|
shipper_estado |
Estado del remitente |
|
|
shipper_cp |
Código Postal del remitente |
|
|
recipient_nombre |
Nombre del destinatario |
|
|
recipient_compania |
Compañía del destinatario |
|
|
recipient_telefono |
Teléfono del destinatario |
|
|
recipient_calle |
Calle del destinatario |
|
|
recipient_calle2 |
Calle del destinatario |
|
|
recipient_ciudad |
Ciudad del destinatario |
|
|
recipient_estado |
Estado del destinatario |
|
|
recipient_cp |
Código 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 |
|
|
valor_mercancia |
Valor del paquete |
|
|
|
packageLineItem_contenido |
Contenido del paquete |
|
|
shipper_rfc |
R.F.C. del remitente |
|
|
|
recipient_rfc |
R.F.C. del destinatario |
|
|
|
pagarSaldoPrepago |
'on/NO' En el caso de querer cubir la operación con saldo prepago / O con guias disponibles |
|
|
|
cp_c_ClaveProdServ |
Clave productos transportados (SAT - Catálogo de productos Carta Porte.- c_ClaveProdServCP) * |
|
|
|
Ejemplo:
guia_tipo:25
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_peso:5
packageLineItem_largo:10
packageLineItem_ancho:10
packageLineItem_alto:10
valor_mercancia:100
packageLineItem_contenido:Prueba
shipper_rfc:XAXX010101000
recipient_rfc:XAXX010101000
pagarSaldoPrepago:on
cp_c_ClaveProdServ:53101602
GET Guía
Regresa la ruta del pdf de la guía correspondiente al tracking proporcionado.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/estafeta/guia
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/estafeta/guia/8050000000130700449234
Paquetexpress
Las peticiones a las tareas relacionadas con Paquetexpress deben contener en la ruta
Paquetexpress/ seguido de la acción a realizar.
GET Historial
Regresa una lista de todas las guías generadas.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/historial
GET Disponibles
Regresa una lista del tipo, peso y cantidad de guías disponibles para generar.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/disponibles
GET Cobertura
Se deben enviar como parámetros en la URL el código postal origen y el código postal destino.
Regresa los servicios disponibles por Paquetexpress y si genera zona extendida
Ruta:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/cobertura
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
cp_origen |
Código Postal de origen |
Numérico 5 caracteres |
|
cp_distino |
Código Postal de destino |
Numérico 5 caracteres |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/cobertura?cp_origen=54435&cp_destino=95085
POST Guía
Genera una guía Paquetexpress
Se deben enviar como parámetros post los datos necesarios para la generación de la guía
Regresa el número de guía y nombre del archivo PDF generado
Ruta:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/guia
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
max. caracteres |
guia_tipo |
Tipo de guía, ver tipos disponibles en (paquetexpress/disponibles) |
|
|
|
guia_peso |
Peso de guía, ver tipos disponibles en (paquetexpress/disponibles) |
|
|
|
guia_tipo_papel |
Tipo papel 0 Media carta default, 1 Tamaño térmico |
|
|
|
guia_rec |
Si la guía tendrá recolección (por el momento esta función no está disponible) |
|
|
|
shipper_nombre |
Nombre del remitente |
|
|
29 |
shipper_compania |
Nombre del negocio del remitente |
|
|
35 |
shipper_telefono |
Teléfono 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 |
Código Postal del remitente |
|
|
5 |
recipient_nombre |
Nombre del destinatario |
|
|
29 |
recipient_compania |
Compañía del destinatario |
|
|
35 |
recipient_telefono |
Teléfono 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 |
Código 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 |
|
|
|
valor_mercancia |
Valor del paquete |
|
|
|
shipper_rfc |
R.F.C. del remitente |
|
|
|
recipient_rfc |
R.F.C. del destinatario |
|
|
|
cp_numeroMercancias |
Número total de Mercancías dentro del paquete * |
|
|
|
cp_descripcion |
Descripción Mercancías transportadas * |
|
|
|
cp_cantidad |
Cantidad total de artículos dentro del paquete * |
|
|
|
cp_peso |
Peso total del paquete (en kilos) * |
|
|
|
cp_c_ClaveProdServ |
Clave productos transportados (SAT - Catálogo de productos Carta Porte.- c_ClaveProdServCP) * |
|
|
|
cp_c_ClaveUnidadPeso |
Clave Unidad de peso (SAT - Catálogo de unidades de medida y embalaje Carta Porte.- c_ClaveUnidadPeso) * |
|
|
|
pagarSaldoPrepago |
'on/NO' En el caso de querer cubir la operación con saldo prepago / O con guias disponibles |
|
|
|
* Carta Porte Nota:
En la página del SAT encontrara "Complemento Carta Porte" donde están los catálogos requeridos en
http://omawww.sat.gob.mx/tramitesyservicios/Paginas/complemento_carta_porte.htm
Catálogos del complemento.
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
valor_mercancia:100
shipper_rfc:XAXX010101000
recipient_rfc:XAXX010101000
cp_numeroMercancias:1
cp_descripcion:Playeras
cp_cantidad:1
cp_peso:1
cp_c_ClaveProdServ:53101602
cp_c_ClaveUnidadPeso:KGM
pagarSaldoPrepago:on
GET Guía
Regresa la ruta del pdf de la guía correspondiente al tracking proporcionado.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/guia
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/guia/787991798487
GET Cancelar
Cancela una guía generada Consultar requerimientos para poder cancelar con su
asesor.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/cancelar
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
tracking |
Número de la guía |
Numérico |
|
Ejemplo:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/cancelar/787991798487
POST Recolección
Genera la recolección de una guía Consultar requerimientos para poder generar recolecciones
con su asesor.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/paquetexpress/recoleccion
Parámetros:
Parámetro |
Descripción |
|
Obligatorio |
shipper_nombre |
Nombre del remitente |
|
|
shipper_compania |
Compañía del remitente |
|
|
shipper_telefono |
Teléfono del remitente |
|
|
shipper_calle |
calle del remitente |
|
|
shipper_colonia |
colonia del remitente |
|
|
shipper_ciudad |
ciudad del remitente |
|
|
shipper_estado |
estado del remitente |
|
|
shipper_cp |
código 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 |
|
|
valor_mercancia |
Valor del paquete |
|
|
|
date_pickup |
fecha de la recolección |
|
|
package_time_ready |
hora en el que el paquete estará listo |
|
|
last_available_hour |
ultima hora en la que puede pasar recolección |
|
|
tracking |
número de guía a la cual generar la recolección |
|
|
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
valor_mercancia:100
date_pickup:2019-12-28
package_time_ready:12:00:00
last_available_hour:18:00:00
tracking:779203417633
Otros
GET Precios
Regresa una lista de todos los precios configurados a su cuenta.
Ruta:
https://sistema.globalpaq.mx/api/v2/public/tienda/precios