Antes de leer la documentación

Por favor ingresa tu API Key en el recuadro de abajo o usa un parametro "key=" en la URL para que la documentación pueda mostrarte datos particulares que necesitas para realizar ciertas peticiones.

🔑

Cuentas facturación

Estas cuentas de facturación son particulares y aplicables a la API Key ingresada en la sección "Antes de leer la documentación"

Cuenta: '{{ cuenta.nombre }}'

Correo: {{cuenta.correoCuenta}}

Centro de Costo: {{cuenta.centroCosto}}

Alias: {{cuenta.aliasCuenta}}

Productos DHL

Estos productos activados son particulares y aplicables a la API Key ingresada en la sección "Antes de leer la documentación"

Producto/Servicio: '{{ servicio.producto }}'

Codigo DHL: {{servicio.producto}}

Descripción: {{servicio.descripcion}}

Referencia API

Esta API respondera a los métodos convencionales de HTTP: GET, POST, PUT y DELETE

Se define como una API JSON, el cual es una estructura de intercambio de información disponible y tratable en cualquier lenguaje de programación.

La primera vez que recibas tu Llave API posterior a tu registro en el sistema de S&G, el modo de comunicación con la API se define como "DESARROLLO" lo que indica que podrás realizar tantas pruebas como necesites.

Una vez que tus pruebas de integración hayan finalizado. Para entrar en modo "PRODUCCIÓN" simplemente deberás solicitarlo en atención al cliente, los cuales cambiaran tu credencial a modo producción sin necesidad de que hagas cambios en tu desarrollo.

Previo a iniciar un desarrollo te recomendamos que hagas uso de algún cliente para probar la API, en particular te recomendamos:

* Insomnia

* PostMan

* SOAPUI

Entrada API

Para empezar a enviar peticiones a la API de S&G y consumir algún recurso debes de seguir la siguiente estructura:

https://shipandgoapps.com.mx:8090/[VERSION_API]/[RECURSO]

Ejemplo:

https://shipandgoapps.com.mx:8090/api/v1/Guia

En el ejemplo anterior vamos a consumir el recurso guía, utilizando la versión v1 alojado en el servidor con IP http://shipandgoapps.com.mx:8080/api/v1/


Actualmente se está manejando la versión v1 de la API, cuando exista una nueva con mejoras se te notificará por correo

Autenticación

Definiendo el encabeza de Autenticación 

curl -X POST https://shipandgoapps.com.mx:8090/api/v1/guia \
-H Content-Type: application/json \
-H Accept: application/json \
-H Key: [LLAVE API]

La autenticación hacia la API de S&G se lleva a cabo mediante el encabezado de autenticación definido en los encabezados de la petición HTTP. Saber más acerca del encabezado de autorización.

Sin embargo, como medida mínima de seguridad no se hace uso del encabezado tradicional de autenticación, sino que S&G define un propio "Key"

Cada recurso disponible en la API validará este encabezado, en caso de estar ausente la petición regresará un código de estatus 401 Códigos de error en S&G

Errores

Nuestra API regresa códigos de estatus estándar del protocolo HTTP. Junto al código de estatus se retorna un JSON con una estructura general que denota el código de error definido por S&G junto a una descripción lo más detallada del error que se está generando. Los diferentes códigos de estatus HTTP se enlistan a continuación.

Códigos de estatus HTTP

Código Titulo Descripción
200 OK Petición correcta
401 Unauthorized Acción no permitida
404 Not found Recurso no disponible
429 Too many requests Has enviado demasiadas peticiones en tan poco tiempo

Estructura de Error

Todos los errores son regresados en una estructura JSON en el cual se incluye un mensaje descriptivo.

Mensaje de error


  {
                        modo: DESARROLLO | PRODUCCION,
                        datos: null,
                        error: {
                        estatus: FORM_VALIDATION,
                        descripcion: Error en el campo 'QTY' verificar
    }
  }
Campo Descripción
estatus Código del error
descripcion Descripción especifica del error

Recursos

Prueba de Entrega ePOD

Recurso definido para poder consultar el comprobante de entrega electrónico

GET | POST
pruebaentrega
JSON BODY o QUERY PARAMS

URL: https://shipandgoapps.com.mx:8090/api/v1/pruebaentrega

Petición:


{
                        guia : 1191058175
}

Respuesta:


{
"modo": "PRODUCCION",
"datos": {
        "formato": "PDF",
        "epod": "PDF_EN_BASE_64"
},
"error": null
}
Campo Tipo Descripción
guia texto Guia de la cual se obtendra el comprobante ePOD

Seguimiento Guía

GET
seguimiento
JSON BODY o QUERY PARAMS

URL: https://shipandgoapps.com.mx:8090/api/v1/seguimiento

Petición:


{
                        idioma: es,
                        guias : [
                        1191058175
   ]
  "soloUltimoMovimiento": true {# opcional por defecto todos los movimientos #}
}

Respuesta:


                     {
                        "modo": "PRODUCCION",
                        "datos": [
                           {
                              "estatus": "OK",
                              "descripcion": "OK",
                              "numeroDeGuia": "8336644735",
                              "informacion": {
                                 "areaOrigen": {
                                    "codigoArea": null,
                                    "descripcion": "Ciudad Juarez-MX",
                                    "codigoEstacion": null
                                 },
                                 "areaDestino": {
                                    "codigoArea": null,
                                    "descripcion": "Mexico City-MX",
                                    "codigoEstacion": "RMX"
                                 },
                                 "nombreRemitente": "CESAR SANCHEZ MARQUEZ",
                                 "cuentaRemitente": null,
                                 "nombreDestinatario": "ING. SERGIO MOCTEZUMA VELASCO",
                                 "fechaDeEnvio": "9/18/2023 4:20:21 PM",
                                 "piezas": 1.0,
                                 "peso": 1.0,
                                 "unidadMedidaPeso": "metric",
                                 "codigoDeProductoGlobal": "N",
                                 "descripcionDeEnvio": "DOCUMENTO",
                                 "notificacionesHabilitadas": null,
                                 "remitente": {
                                    "ciudad": "JUAREZ",
                                    "codigoDivision": null,
                                    "codigoPostal": "32540",
                                    "codigoPais": "MX"
                                 },
                                 "destinatario": {
                                    "ciudad": "SAN JUAN-BENITO JUAREZ",
                                    "codigoDivision": null,
                                    "codigoPostal": "03730",
                                    "codigoPais": "MX"
                                 },
                                 "eventos": [
                                    {
                                       "fecha": "2023-09-19",
                                       "hora": "14:42:00",
                                       "evento": {
                                          "codigoEvento": "PU",
                                          "descripcion": "Shipment picked up"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-19",
                                       "hora": "19:30:00",
                                       "evento": {
                                          "codigoEvento": "AF",
                                          "descripcion": "Arrived at DHL Sort Facility  CIUDAD JUAREZ-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-19",
                                       "hora": "19:33:00",
                                       "evento": {
                                          "codigoEvento": "PL",
                                          "descripcion": "Processed at CIUDAD JUAREZ-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-19",
                                       "hora": "19:35:00",
                                       "evento": {
                                          "codigoEvento": "DF",
                                          "descripcion": "Shipment has departed from a DHL facility CIUDAD JUAREZ-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-20",
                                       "hora": "00:47:00",
                                       "evento": {
                                          "codigoEvento": "AF",
                                          "descripcion": "Arrived at DHL Sort Facility  QUERETARO-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-20",
                                       "hora": "02:29:00",
                                       "evento": {
                                          "codigoEvento": "PL",
                                          "descripcion": "Processed at QUERETARO-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-20",
                                       "hora": "02:30:00",
                                       "evento": {
                                          "codigoEvento": "DF",
                                          "descripcion": "Shipment has departed from a DHL facility QUERETARO-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-20",
                                       "hora": "05:14:00",
                                       "evento": {
                                          "codigoEvento": "AF",
                                          "descripcion": "Arrived at DHL Sort Facility  MEXICO CITY HUB-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-20",
                                       "hora": "06:08:00",
                                       "evento": {
                                          "codigoEvento": "PL",
                                          "descripcion": "Processed at MEXICO CITY HUB-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-20",
                                       "hora": "06:36:00",
                                       "evento": {
                                          "codigoEvento": "DF",
                                          "descripcion": "Shipment has departed from a DHL facility MEXICO CITY HUB-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-20",
                                       "hora": "07:47:00",
                                       "evento": {
                                          "codigoEvento": "AR",
                                          "descripcion": "Arrived at DHL Delivery Facility  MEXICO CITY-MEXICO"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-20",
                                       "hora": "09:24:00",
                                       "evento": {
                                          "codigoEvento": "WC",
                                          "descripcion": "Shipment is out with courier for delivery"
                                       },
                                       "firmadoPor": null
                                    },
                                    {
                                       "fecha": "2023-09-20",
                                       "hora": "14:26:00",
                                       "evento": {
                                          "codigoEvento": "OK",
                                          "descripcion": "Delivered"
                                       },
                                       "firmadoPor": "Carlos vigil"
                                    }
                                 ]
                              }
                           }
                        ],
                        "error": null
                     }
Campo Tipo Descripción
idioma texto Idioma en el que se requiere recibir los eventos 'es' | 'en', español e ingles respectivamente
guias Array texto Las guías a consultar, con un máximo de 10 guías por petición

Nota 1: solo se puede consultar el PDF hasta por 2 días posteriores a la generación de la guía , pasado este tiempo solo se mostrara la información sin la posibilidad de obtener la guía en formato PDF

Nota 2: Es importante señalar que en el ambiente de prueba no tendrá disponible este servicio

Consulta Guía

GET
GUIA
JSON BODY o QUERY PARAMS

URL: https://shipandgoapps.com.mx:8090/api/v1/guia

Petición:


{
                        guias : [
                        1191058175
   ]
  
}

Respuesta:


{
   "modo": "DESARROLLO",
   "datos": [
      {
         "estatus": "OK",
         "descripcion": "Guía en PDF disponible solo 48 horas, campo 'guiaPDF'",
         "guia": {
         "IdGuiaGenerada": 1,
         "NumeroDeGuia": "1172480702",
         "CodigoFacturacion": "DSA",
         "CodigoDenominacion": "MXN",
         "AreaOrigenCodigo": "MEX",
         "AreaOrigenEstacion": "HMX",
         "CodigoEntrante": null,
         "AreaDestinoCodigo": "ACA",
         "AreaDestinoEstacion": "ACA",
         "CodigoSaliente": null,
         "CargoPorPaquete": 2222.62,
         "Calificado": "Y",
         "CostoDeEnvio": 3171.96,
         "UnidadDePeso": "K",
         "PesoTarifado": 142.00,
         "PesoDimensional": 43.60,
         "CodigoDePais": "MX",
         "Piezas": 2.00,
         "Contenido": "Caja de vidrio fragil",
         "DestinatarioNombre": "Roberto Robles",
         "DestinatarioTelefono": "1343432432432",
         "DestinatarioCorreo": null,
         "DestinatarioCompania": "N/A",
         "DestinatarioDireccion": "Ex hacienda san miguel cuautitlan",
         "DestinatarioCiudad": "Iliatenco",
         "DestinatarioCodigoPostal": "41530",
         "DestinatarioCodigoPais": "MX",
         "DestinatarioPais": "MEXICO",
         "RemitenteId": "fgRp5jX5Gg==",
         "RemitenteNombre": "Roberto Robles",
         "RemitenteTelefono": "1343432432432",
         "RemitenteCorreo": null,
         "RemitenteCompania": "DHL EXPRESS MEXICO",
         "RemitenteDireccion": "Av. Revolucion #",
         "RemitenteCiudad": "Venustiano Carranza",
         "RemitenteCodigoPostal": "15520",
         "RemitenteCodigoPais": "MX",
         "RemitentePais": "MEXICO",
         "IdCliente": "300902",
         "FechaEnvio": "2021-01-31",
         "AliasProductoDhl": "N",
         "CodigoProductoDhl": "DOM",
         "ProductoDhl": "EXPRESS DOMESTIC",
         "CuentaFacturacion": "980350748",
         "CodigoEnrutamientoDhl": "MX41530+46000000",
         "IdEnrutamientoDhl": "2L",
         "CodigoServicioInterno": "",
         "CodigoFechaEntrega": "",
         "CodigoHoraEntrega": "",
         "Rfc": "AAB170207A1A ",
         "CorreoCuenta": "ROSA@FUEGODIRECTO.COM",
         "CentroCosto": "MM-FUEGO DIRECTO",
         "Creado": "2021-03-02T15:32:11.743",
         "PaqueteGuiaGenerada": [
            {
               "IdPaqueteGuiaGenerada": 1,
               "IdPieza": "1",
               "Largo": 121.00,
               "Ancho": 30.00,
               "Alto": 30.00,
               "Peso": 71.00,
               "TipoPaquete": "CP",
               "PesoDimensional": 21.78,
               "Identificador": "J",
               "Placas": "JD011100003643110504",
               "IdGuiaGenerada": 1,
               "Creado": "2021-01-31T15:32:11.757"
            },
            {
               "IdPaqueteGuiaGenerada": 2,
               "IdPieza": "2",
               "Largo": 121.00,
               "Ancho": 30.00,
               "Alto": 30.00,
               "Peso": 71.00,
               "TipoPaquete": "CP",
               "PesoDimensional": 21.78,
               "Identificador": "J",
               "Placas": "JD011100003643110505",
               "IdGuiaGenerada": 1,
               "Creado": "2021-01-31T15:32:11.757"
            }
         ]
         },
         "guiaPDF": null
      }
   ],
   "error": null
   }
Campo Tipo Descripción
guias Array texto Las guías a consultar, con un máximo de 10 guías por petición

Nota 1: solo se puede consultar el PDF hasta por 2 días posteriores a la generación de la guía , pasado este tiempo solo se mostrara la información sin la posibilidad de obtener la guía en formato PDF

Nota 2: Es importante señalar que en el ambiente de prueba no tendrá disponible este servicio

Guía Nacional

POST
guia

URL: https://shipandgoapps.com.mx:8090/api/v1/Guia

Petición:


    {
    "facturacion":{
    //Ver estos datos en sección "Cuentas facturación"
    "correoCuenta": "",
    "centroCosto": "",
    "productoDHL": "",
    "aliasCuenta": "",
    //Ver estos datos en sección "Cuentas facturación"
    "generarRecoleccion"(opcional): true | false
    },
    "remitente": {
    "nombre" : "mario garcia",
    "telefono" : "55858345",
    "codigoPostal": 10340,
    "nombreCompania" : "DHL EXPRESS MEXICO",
    "lineaDireccion" : [
    "Av. Revolucion #"
    ],
    "correo: " nombre@mail.com
    },
    "destinatario": {
    "codigoPostal": 41530, {# CP Error: 06720 #}
    "nombre" : "toña martinez",
    "telefono" : "5589485767",
    "nombreCompania" : "N/A",
    "lineaDireccion" : [
    "Ex hacienda san miguel cuautitlan"
    ],
    "correo: " nombre@mail.com
    },
    "detallesEnvio": {
    "fechaDeEnvio": "2022-01-24",
    "descripcionContenido": "Caja de vidrio fragil",
    "montoAsegurado": 0,
    "monedaMontoAsegurado": "MXN",
    "paquetes": [
    {
    "peso": 6,
    "alto": 10,
    "ancho": 10,
    "largo": 10
    }
    ],
    "tipoImpresora": "PDF",
    "formatoEtiqueta": "ECOM26_84_A4_001",
    "incluirWaybill": true,
    "formatoWaybill": "ARCH_8X4_A4_002"
    }
    }

Respuesta:


{
   "modo": "DESARROLLO",
   "datos": {
      "numeroDeGuia": "1195198175",
      "centroDeCosto": "CENTRO COSTO 1",
      "cuentaAlias": "C",
      "RFC": "ABC123",
      "cotizacion": {
         "productoDHL": "G",
         "nombreProductoDHL": "ECONOMY SELECT DOMESTIC",
         "tipoMoneda": "MXN",
         "fechaEstimadaEntrega": "2021-03-11 11:59:00",
         "pesoDimensional": 43.2,
         "unidadDePeso": "KG",
         "pesoFacturable": 142.0,
         "preciosEstimados": [
         {
            "zona": "D",
            "idTarifaNormal": 1,
            "pesoTotal": 142,
            "pesoTarifaNormal": 7,
            "pesoTarifaAdicional": 135,
            "costoTarifaNormal": 117.99,
            "costoTarifaAdicional": 18.53,
            "subTotal": 3512.08,
            "impuestos": 561.93,
            "precioEstimadoTotal": 4074.01,
            "detalles": [
               {
               "concepto": "ECONOMY SELECT DOMESTIC (G)",
               "costoSinImpuestos": 2619.54
               },
               {
               "concepto": "Modalidad multipiezas",
               "costoSinImpuestos": 79.83
               },
               {
               "concepto": "Peso excedido (Sobrepeso)",
               "costoSinImpuestos": 470.38
               },
               {
               "concepto": "Cargo por combustible",
               "costoSinImpuestos": 342.33
               }
            ]
         }
         ]
      },
      "codigoDenominacion": "MXN",
      "areaDestino": {
         "codigoArea": "VER",
         "codigoEstacion": "VER"
      },
      "areaOrigen": {
         "codigoArea": "GDL",
         "codigoEstacion": "GDL"
      },
      "unidadDePeso": "K",
      "pesoTarifado": 142.0,
      "pesoDimensional": 43.2,
      "codigosDeBarras": {
         "guia": "[CODIGO_BARRAS_BASE_64]",
         "origenDestino": "[CODIGO_BARRAS_BASE_64]",
         "enrutamientoDHL": "[CODIGO_BARRAS_BASE_64]"
      },
      "piezas": 2,
      "contenido": "Caja de vidrio fragil",
      "identificacionCliente": "300902",
      "fechaDeEnvio": "2021-03-09",
      "codigoProductoDHL": "G",
      "productoDHL": "ECONOMY SELECT DOMESTIC",
      "paquetes": {
         "paquete": [
         {
            "numeroPieza": "1",
            "largo": 120.0,
            "ancho": 30.0,
            "alto": 30.0,
            "peso": 71.0,
            "pesoDimensional": 21.6,
            "numeroPlaca": "JD011100003645344849",
            "codigoNumeroPlaca": "[CODIGO_BARRAS_BASE_64]"
         },
         {
            "numeroPieza": "2",
            "largo": 120.0,
            "ancho": 30.0,
            "alto": 30.0,
            "peso": 71.0,
            "pesoDimensional": 21.6,
            "numeroPlaca": "JD011100003645344850",
            "codigoNumeroPlaca": "[CODIGO_BARRAS_BASE_64]"
         }
         ]
      },
      "multiplesDetallesFacturacion": [
         {
         "denominacion": "MXN",
         "codigoRolDenominacion": "BILLC",
         "costoPorPaquete": 2222.62,
         "costoDeEnvio": 3226.27
         },
         {
         "denominacion": "MXN",
         "codigoRolDenominacion": "PULCL",
         "costoPorPaquete": 2222.62,
         "costoDeEnvio": 3226.27
         },
         {
         "denominacion": "EUR",
         "codigoRolDenominacion": "BASEC",
         "costoPorPaquete": 87.75,
         "costoDeEnvio": 127.37
         }
      ],
      "etiquetaImprimible": {
         "etiquetaPDF": "[ARCHIVO_PDF_BASE_64]"
      }
   },
   "error": null
   }
Campo Tipo Descripción Correo
facturacion Facturación Información referente a las cuentas de facturación en S&G, Ir Cuentas facturación
remitente Datos persona Información detallada del remitente Correo del remitente
destinatario Datos persona Información detallada del destinatario Correo del destinatario
detallesEnvio Datos paquete Detalle de fecha, descripción y dimensiones de los paquetes a enviar
generarRecoleccion [true | false] permite generar guía y recolección en un mismo request

Facturación

Campo Tipo Descripción
correoCuenta Texto Correo asignado a la cuenta
centroCosto Texto Centro de costo hacia donde asignar facturación
productoDHL Texto Producto/Servicio DHL a consumir, Ir Productos DHL
aliasCuenta Texto Cuenta asignada al centro de costo

Datos persona

Campo Tipo Descripción
nombre Texto Información detallada del remitente
telefono Texto Información detallada del remitente
codigoPostal Codigo postal Información detallada del remitente
nombreCompania Texto Información detallada del remitente
lineaDireccion Texto Dirección del remitente arreglo con 3 líneas de 45 caracteres cada una

Datos paquete

Campo Tipo Descripción
fechaDeEnvio Fecha YYYY-MM-DD Fecha en que se realizará el envio
descripcionContenido Texto Descripción breve del contenido del paquete
montoAsegurado Entero Monto por el cual asegurar el contenido de la guía (opcional)
monedaMontoAsegurado Tipo moneda Tipo de moneda del monto asegurado
paquetes Array Paquete Información de los paquetes a enviar
tipoImpresora Texto Formato para imprimir
formatoEtiqueta Texto Formato de etiqueta
incluirWaybill Booleano Se incluira hoja de ruta en el PDF de la guia
formatoWaybill Texto Formato del waybill

Paquete

Campo Tipo Descripción
peso Decimal Peso del envió expresado en Kilogramos
alto Entero Medida alto expresada en Centímetros
ancho Entero Medida ancho expresada en Centímetros
largo Entero Medida largo expresada en Centímetros

Formato para imprimir

Tipo Descripción
PDF (Portable Document Format)
ZPL (Zebra Programming Language version 1)
LP2 (Label Print Language version 1)
EPL (Eltron Programming Language version 1)

Formato de etiqueta

Tipo
ECOM26_84_A4_001
ECOM26_84_001 (Común DHL)
ECOM_TC_A4
ECOM26_A6_002
ECOM26_84CI_001
ECOM26_84CI_002 - supported single customer barcode
COM26_84CI_003 - to be used if customer barcodes are used
ECOM_A4_RU_002

Formato del waybill

Tipo
ARCH_8X4_A4_002
ARCH_8X4 (Común DHL)
ARCH_6X4
ARCH_A4_RU_002

Guía Internacional

POST
guia

URL: https://shipandgoapps.com.mx:8090/api/v1/Guia

Petición:


    {
    "facturacion":{
        //Ver estos datos en sección "Cuentas facturación"
        "correoCuenta": "",
        "centroCosto": "",
        "productoDHL": "",
        "aliasCuenta": "",
        //Ver estos datos en sección "Cuentas facturación"
        "generarRecoleccion"(opcional): true | false
    },
    "remitente": {
        "nombre" : "mario garcia",
        "telefono" : "55858345",
        "codigoPostal": 10340,
        "nombreCompania" : "DHL EXPRESS MEXICO",
        "lineaDireccion" : [
        "Av. Revolucion #"
        ],
        "correo: " nombre@mail.com
    },
    "destinatario": {
        "ciudad": "AKRON",
        "codigoPostal": 14001, {# CP Error: 06720 #}
        "codigoPais": "US",
        "nombrePais": "UNITED STATES OF AMERICAN",
        "nombre" : "MILOS TEODORITO",
        "telefono" : "506-851-2271",
        "correo": "c_orlander@gc.ca",
        "nombreCompania" : "N/A",
        "lineaDireccion" : [
        "AKRON  Los Ángeles, 58"
        ],
        "correo: " nombre@mail.com
    },
    "detallesEnvio": {
        "fechaDeEnvio": "2021-06-06",
        "descripcionContenido": "Caja de vidrio fragil",
        "codigoProductoExportacion": "6405.90.9060",
        "describeProductoExportacion": "Other - Other footwear",
        "valorDeclarado": "70.0",
        "monedaValorDeclarado": "USD",
        "reglaTransportacion": "DDP",
        "useFacturaDhl": "Y",
        "lenguajeFactura": "en",
        "codigoFactura": "CMI",
        "nombreFirmaExportacion": "NOMBRE",
        "tituloFirmaExportacion": "Mr.",
        "razonExportacion": "Commercial",
        "folioFactura": "MX - 20210113 - 123",
        "fechaFactura": "2020-01-13",
        "estatusProceso": "Successfully processed",
        "referenciaRecibo": "ReceiverReference",
        "paquetes": [
            {
            "peso": 6,
            "alto": 10,
            "ancho": 10,
            "largo": 10
            }
        ],
        "tipoImpresora": "PDF",
        "formatoEtiqueta": "ECOM26_84_A4_001",
        "paquetesDeclarados": [
        {
            "numeroLinea": "1",
            "cantidad": "1",
            "unidadCantidad": "PCS",
            "descripcion": "FOOTWEAR",
            "valor": "30.0",
            "domestico": "Y",
            "codigoProducto": "6405.90.9060",
            "peso": "1.0",
            "unidadPeso": "K",
            "pesoBruto": "1.0",
            "unidadPesoBruto": "K",
            "codigoCiudadFabricacion": "MX"

        }
    ],
    "pagoDelImpuestoPor": "S"

    }
    }

Respuesta:


{
	"modo": "DESARROLLO",
	"datos": {
		"numeroDeGuia": "1264275235",
		"centroDeCosto": "VIANNEY 1",
		"cuentaAlias": "C",
		"RFC": "VTH981105F90",
		"cotizacion": {
			"productoDHL": "P",
			"nombreProductoDHL": "EXPRESS WORLDWIDE",
			"tipoMoneda": "USD",
			"fechaEstimadaEntrega": "2022-02-04 11:59:00",
			"pesoDimensional": 0.2,
			"unidadDePeso": "KG",
			"pesoFacturable": 6.0,
			"preciosEstimadosD": null,
			"preciosEstimados": null,
			"preciosEstimadosI": [
				{
					"pesoTotalFacturable": 6,
					"pesoTarifaBase": 6,
					"pesoKilogramosAdicionales": 0,
					"tipoDeCambio": 21.4177,
					"valorDeDescuento": "EXPRESS WORLDWIDE (P) :: 10 % descuento aplicado",
					"tarifaBase sin descuento U.S. $": 103.5,
					"tarifaBase sin descuento Pesos M.N.": 2216.73,
					"tarifaBase con descuento U.S. $": 93.15,
					"tarifaBase con descuento Pesos M.N.": 1995.05,
					"costoKiloAdicional U.S. $": 0.0,
					"tarifaKiloAdicional sin descuentoU.S. $": 0.0,
					"tarifaKiloAdicional sin descuento Pesos M.N.": 0.0,
					"tarifaKiloAdicional con descuento U.S. $": 0.0,
					"tarifaKiloAdicional con descuento Pesos M.N.": 0.0,
					"subTotalFlete": {
						"concepto": "EXPRESS WORLDWIDE (P) :: 10 % descuento aplicado",
						"costoSinImpuestos U.S. $": 93.15,
						"costoSinImpuestos Pesos M.N.": 1995.05
					},
					"cargosAdicionales": [
						{
							"concepto": "Situación de emergencia",
							"costoSinImpuestos U.S. $": 0.0,
							"costoSinImpuestos Pesos M.N.": 0.0
						},
						{
							"concepto": "SubTotal antes de combustible",
							"costoSinImpuestos U.S. $": 93.15,
							"costoSinImpuestos Pesos M.N.": 1995.05
						},
						{
							"concepto": "Cargo por combustible tarifa 23.2 %",
							"costoSinImpuestos U.S. $": 21.61,
							"costoSinImpuestos Pesos M.N.": 462.83
						},
						{
							"concepto": "Pago de impuestos en origen",
							"costoSinImpuestos U.S. $": 29.83,
							"costoSinImpuestos Pesos M.N.": 638.88
						}
					],
					"subTotal U.S. $": 144.59,
					"impuestos U.S. $": 5.78,
					"precioEstimadoTotal U.S. $": 150.37,
					"tipoDeCambio_": 21.4177,
					"subTotal Pesos M.N.": 3096.78,
					"impuestos Pesos M.N.": 123.79,
					"precioEstimadoTotal Pesos M.N.": 3220.57
				}
			]
		},
		"codigoDenominacion": "USD",
		"areaDestino": {
			"codigoArea": "ROC",
			"codigoEstacion": "ROC"
		},
		"areaOrigen": {
			"codigoArea": "MEX",
			"codigoEstacion": "NMX"
		},
		"unidadDePeso": "K",
		"pesoTarifado": 6.0,
		"pesoDimensional": 0.2,
		"codigosDeBarras": {
			"guia": "iVBORw0KGgoAAAANSUhEUgAAAWgAAABeAQMAAAA0fxySAAAABlBMVEX///8AAABVwtN+AAAAYElEQVR42mNkYGBItL2tetjCd9I7YdUGD4YdnkYeO3yrbW/nWngwyj80v/WO0fChwtvPuVIMDEwMpIBR1aOqR1WPqh5VPap6VPWo6lHVo6pHVY+qHlU9qnpU9ahqeqkGANykEbx1nsl4AAAAAElFTkSuQmCC",
			"origenDestino": "iVBORw0KGgoAAAANSUhEUgAAARoAAABeAQMAAADGw0k3AAAABlBMVEX///8AAABVwtN+AAAAUElEQVR42mNkYGBItL2telv+vJHHjrefVW8reOw9aXje/LAF623e27a32RsYGJgYiACjikYVjSoaVTSqaFTRqKJRRaOKRhWNKhpVNKqIdEUAyS0PvPy8oUoAAAAASUVORK5CYII=",
			"enrutamientoDHL": "iVBORw0KGgoAAAANSUhEUgAAAcIAAABeAQMAAACKBYaKAAAABlBMVEX///8AAABVwtN+AAAAa0lEQVR42u3LIRJAQABG4X/NrCYjuY4z7Akk3QhW05UdwXARZ9nqDALOoJl5L73yGUld1se83cMddfkpdTaYqnGFaY5ai52j9braTbmX3DmMw3qW7yb6GhKJRCKRSCQSiUQikUgkEolE/k0+2IgVvKeNDAcAAAAASUVORK5CYII="
		},
		"piezas": 1,
		"contenido": "Caja de vidrio fragil",
		"identificacionCliente": "300902",
		"fechaDeEnvio": "2022-02-01",
		"codigoProductoDHL": "P",
		"productoDHL": "EXPRESS WORLDWIDE",
		"paquetes": {
			"paquete": [
				{
					"numeroPieza": "1",
					"largo": 10.0,
					"ancho": 10.0,
					"alto": 10.0,
					"peso": 6.0,
					"pesoDimensional": 0.2,
					"numeroPlaca": "JD011100003657595014",
					"codigoNumeroPlaca": "iVBORw0KGgoAAAANSUhEUgAAAZYAAABeAQMAAAA6+qC4AAAABlBMVEX///8AAABVwtN+AAAAa0lEQVR42mNmYGCo9No3T/942Z65Vz6Yb2lLLRexc7udaWO7tFBvO8sT1ctFy1jvvuV2WcIXcenHY9YjDAxMDKSDUT2jekb1jOoZ1TOqZ1TPqJ5RPaN6RvWM6hnVM6pnVM+onlE9o3oGkx4AYA4XmebgGt0AAAAASUVORK5CYII="
				}
			]
		},
		"multiplesDetallesFacturacion": [
			{
				"denominacion": "USD",
				"codigoRolDenominacion": "BILLC",
				"costoPorPaquete": 56.93,
				"costoDeEnvio": 62.91
			},
			{
				"denominacion": "MXN",
				"codigoRolDenominacion": "PULCL",
				"costoPorPaquete": 1174.77,
				"costoDeEnvio": 1298.17
			},
			{
				"denominacion": "EUR",
				"codigoRolDenominacion": "BASEC",
				"costoPorPaquete": 51.02,
				"costoDeEnvio": 56.39
			}
		],
		"etiquetaImprimible": {
			"etiquetaPDF": "[ARCHIVO_PDF_BASE_64]",
			"multietiquetas": {
				"etiqueta": [
					{
						"nombreDocumento": "CustomInvoiceImage",
						"formatoDocumento": "PDF",
						"facturaDhl": "[ARCHIVO_PDF_BASE_64]"
					}
				]
			}
		}
	},
	"error": null
}
Campo Tipo Descripción Correo
facturacion Facturacion Información referente a la facturación, Ir Cuentas facturación
remitente Datos remitente Información detallada del remitente Correo del remitente
destinatario Datos destinatario Información detallada del destinatario Correo del destinatario
detallesEnvio Datos paquete Detalle de fecha, descripción y dimensiones de los paquetes a enviar
paquetesDeclarados Datos paquete Detalle de los paquetes
generarRecoleccion 'generarRecoleccion' [true | false] permite generar guía y recolección en un mismo request

Facturación

Campo Tipo Descripción
correoCuenta Texto Correo asignado a la cuenta
centroCosto Texto Centro de costo hacia donde asignar facturación
productoDHL Texto Producto/Servicio DHL a consumir, Ir Productos DHL
aliasCuenta Texto Cuenta asignada al centro de costo

Datos remitente

Campo Tipo Descripción
nombre Texto Información detallada del remitente
telefono Texto Información detallada del remitente
codigoPostal Código postal Información detallada del remitente
nombreCompania Texto Información detallada del remitente
lineaDireccion Texto Dirección del remitente arreglo con 3 líneas de 45 caracteres cada una

Datos destinatario

Campo Tipo Descripción
ciudad Texto Información detallada del destinatario
codigoPostal Codigo postal Información detallada del destinatario
codigoPais Codigo pais Información detallada del destinatario
nombrePais Texto Información detallada del destinatario
nombre Texto Información detallada del destinatario
telefono Texto Información detallada del destinatario
correo Texto Información detallada del destinatario
nombreCompania Texto Información detallada del destinatario
lineaDireccion Texto Dirección del destinatario arreglo con 3 líneas de 45 caracteres cada una

Datos paquete

Campo Tipo Descripción
fechaDeEnvio Fecha YYYY-MM-DD Fecha en que se realizará el envío
descripcionContenido Texto Descripción breve del contenido del paquete
codigoProductoExportacion Texto Código del producto enviado
describeProductoExportacion Texto Datos del producto a exportar
valorDeclarado Entero Valor declarado
monedaValorDeclarado Texto Moneda del valor declarado
reglaTransportacion DDP Dato de transportación
useFacturaDhl Texto (N) Factura de cliente (S) Factura generada por DHL
lenguajeFactura en Idioma de la factura
codigoFactura CMI Código de la factura
nombreFirmaExportacion Texto Nombre del exportador
tituloFirmaExportacion Texto Título del exportador (Mr., Sr. Lic...)
razonExportacion Texto Datos de la exportación
folioFactura Texto Datos de la exportación
fechaFactura Fecha YYYY-MM-DD Fecha de la factura
estatusProceso Texto Estatus de la exportación
referenciaRecibo Texto Referencia
montoAsegurado Entero Monto por el cual asegurar el contenido de la guía (opcional)
monedaMontoAsegurado Tipo de moneda Tipo de moneda del monto asegurado
paquetes Array Paquete Información de los paquetes a enviar
tipoImpresora PDF Formato para imprimir
tipoImpresora 8X4_PDF Formato de etiqueta
paquetesDeclarados Array Paquetes declarados Información de los paquetes a enviar
pagoDelImpuestoPor Texto (S) Remitente, (D) Destinatario

Paquete

Campo Tipo Descripción
peso Decimal Datos del paquete
alto Entero Datos del paquete
ancho Entero Datos del paquete
largo Entero Datos del paquete

Paquetes declarados

Campo Tipo Descripción
numeroLinea Entero Consecutivo de los envíos
cantidad Entero Cantidad de paquetes en cada envío
unidadCantidad PCS Unidad de medida
descripcion Texto Descripción del envío
valor Entero Valor del envío
domestico N Descripción del envío
codigoProducto Texto Código del producto del envío
peso Numero Peso del producto
unidadPeso K Unidad de medida
pesoBruto Numero Peso Total
unidadPesoBruto K Unidad de medida
codigoCiudadFabricacion Codigo Ciudad Ciudad

Formato para imprimir

Tipo Descripción
EPL2 (Eltron Programming Language version 2)
PDF (Portable Document Format)
ZPL2 (Zebra Programming Language version 2)

Formato de etiqueta

Tipo
ECOM26_84_A4_001
ECOM26_84_001 (Común DHL)
ECOM_TC_A4
ECOM26_A6_002
ECOM26_84CI_001
ECOM26_84CI_002 - supported single customer barcode
COM26_84CI_003 - to be used if customer barcodes are used
ECOM_A4_RU_002

Cotización Nacional

POST
cotizacion

URL: https://shipandgoapps.com.mx:8090/api/v1/cotizacion

Petición:


    {
    "facturacion":{
        //Ver sección "Cuentas de facturación"
        "productoDHL": "", //El producto DHL a cotizar
        "aliasCuenta": "", //El alias de cuenta correspondiente de facturación
        //Ver sección "Cuentas de facturación" 
    },
    "desde":{
    "codigoPais" : "MX", {# opcional #}
    "codigoPostal": 06470,
    "ciudad:" CDMX
    },
    "hasta":{
    "codigoPais" : "MX", {# opcional #}
    "codigoPostal": 72010,
    "ciudad:" Puebla
    },
    "detalles": {
    "esInternacional": false, {# opcional #}
    "fechaDeEnvio": "2022-01-26",
    "horaAlistamiento": "14:15",
    "paquetes": [
    {
    "peso": 20,
    "alto": 10,
    "ancho": 10,
    "largo": 10
    }
    ],
    "montoAsegurado" : 0, {# opcional #}
    "monedaMontoAsegurado" : "MXN", {# opcional #}
    }
    }

Respuesta:


{
	"modo": "DESARROLLO",
	"datos": [
		{
			"productoDHL": "G",
			"nombreProductoDHL": "ECONOMY SELECT DOMESTIC",
			"tipoMoneda": "MXN",
			"fechaEstimadaEntrega": "2022-01-27 11:59:00",
			"pesoDimensional": 0.2,
			"unidadDePeso": "KG",
			"pesoFacturable": 20.0,
			"preciosEstimadosNacional": [
				{
					"pesoTotalFacturable": 20,
					"pesoTarifaBase": 10,
					"pesoKilogramosAdicionales": 10,
					"tarifaBase Pesos M.N.": 177.23,
					"costoKiloAdicional M.N. $": 22.49,
					"tarifaKiloAdicional Pesos M.N.": 224.89,
					"subTotalFlete": {
						"concepto": "ECONOMY SELECT DOMESTIC (G), N*",
						"costoSinImpuestos Pesos M.N.": 402.12
					},
					"cargosAdicionales": [
						{
							"concepto": "SubTotal antes de combustible",
							"costoSinImpuestos Pesos M.N.": 402.12
						},
						{
							"concepto": "Cargo por combustible tarifa 12.6 %",
							"costoSinImpuestos Pesos M.N.": 50.66
						},
						{
							"concepto": "Seguro de envío (Protección del valor del envío)*",
							"costoSinImpuestos Pesos M.N.": 78.98
						}
					],
					"subTotal Pesos M.N.": 531.76,
					"impuestos Pesos M.N.": 85.08,
					"precioEstimadoTotal Pesos M.N.": 616.84
				}
			],
			"preciosEstimados": null,
			"preciosEstimadosI": null
		}
	],
	"error": null
}
Campo Tipo Descripción
facturacion Facturacion Información referente a las cuentas de facturación en S&G, Ir Cuentas facturación
desde Ciudad Información detallada del remitente
hasta Ciudad Información detallada del destinatario
detalles Datos paquete Detalle de fecha, descripción y dimensiones de los paquetes a enviar

Facturación

Campo Tipo Descripción
aliasCuenta Texto Cuenta asignada al centro de costo
productoDHL Texto Producto/Servicio DHL a consumir, Ir Productos DHL

Datos persona

Campo Tipo Descripción
codigoPais Codigo Pais Información del remitente
codigoPostal Codigo postal Información del remitente

Datos paquete

Campo Tipo Descripción
esInternacional false Es nacional
fechaDeEnvio Fecha YYYY-MM-DD Fecha en la que se realizará el envío
horaAlistamiento Hora HH:MM Hora en la que el envío estará listo
paquetes Array Paquete Información de los paquetes a enviar
montoAsegurado Entero Monto por el cual asegurar el contenido de la guía (opcional)
monedaMontoAsegurado Texto Tipo de moneda

Paquete

Campo Tipo Descripción
peso Decimal Datos del paquete
alto Entero Datos del paquete
ancho Entero Datos del paquete
largo Entero Datos del paquete

Cotización Internacional

POST
cotizacion

URL: https://shipandgoapps.com.mx:8090/api/v1/cotizacion

Petición:


    {
    "facturacion":{
        //Ver sección "Cuentas de facturación"
        "productoDHL": "", //El producto DHL a cotizar
        "aliasCuenta": "", //El alias de cuenta correspondiente de facturación
        //Ver sección "Cuentas de facturación"
    },
    "desde":{
    "codigoPais" : "MX", {# opcional #}
    "codigoPostal": "64290",
    "ciudad:" no es obligatorio
    },
    "hasta":{
    "ciudad": "XXX CITY",
    "codigoPostal": "11010", {# CP Error: 06720 #}
    "codigoPais": "US",
    "nombrePais": "AAA STATES OF AMERICAN",
    "ciudad:" USA
    },
    "detalles": {
    "esInternacional": true, {# opcional #}
    "fechaDeEnvio": "2022-01-31",
    "horaAlistamiento": "11:15",
    "valorDeclarado": "0.0",
    "monedaValorDeclarado": "USD",
    "paquetes": [
    {
    "peso": 5,
    "alto": 10,
    "ancho": 10,
    "largo": 10
    }
    ],
    "pagoDelImpuestoPor": "S",
    "montoAsegurado" : 10000, {# opcional #}
    "monedaMontoAsegurado" : "USD" {# opcional #}
    }
    }

Respuesta:


{
	"modo": "DESARROLLO",
	"datos": [
		{
			"productoDHL": "P",
			"nombreProductoDHL": "EXPRESS WORLDWIDE",
			"tipoMoneda": "USD",
			"fechaEstimadaEntrega": "2022-02-01 11:59:00",
			"pesoDimensional": 0.2,
			"unidadDePeso": "KG",
			"pesoFacturable": 5.0,
			"preciosEstimadosInternacional": [
				{
					"pesoTotalFacturable": 5,
					"pesoTarifaBase": 5,
					"pesoKilogramosAdicionales": 0,
					"tipoDeCambio": 21.4177,
					"valorDeDescuento": "EXPRESS WORLDWIDE (P) :: 10 % descuento aplicado",
					"tarifaBase sin descuento U.S. $": 94.18,
					"tarifaBase sin descuento Pesos M.N.": 2017.11,
					"tarifaBase con descuento U.S. $": 84.76,
					"tarifaBase con descuento Pesos M.N.": 1815.36,
					"costoKiloAdicional U.S. $": 0.0,
					"tarifaKiloAdicional sin descuentoU.S. $": 0.0,
					"tarifaKiloAdicional sin descuento Pesos M.N.": 0.0,
					"tarifaKiloAdicional con descuento U.S. $": 0.0,
					"tarifaKiloAdicional con descuento Pesos M.N.": 0.0,
					"subTotalFlete": {
						"concepto": "EXPRESS WORLDWIDE (P) :: 10 % descuento aplicado",
						"costoSinImpuestos U.S. $": 84.76,
						"costoSinImpuestos Pesos M.N.": 1815.36
					},
					"cargosAdicionales": [
						{
							"concepto": "Situación de emergencia",
							"costoSinImpuestos U.S. $": 0.0,
							"costoSinImpuestos Pesos M.N.": 0.0
						},
						{
							"concepto": "SubTotal antes de combustible",
							"costoSinImpuestos U.S. $": 84.76,
							"costoSinImpuestos Pesos M.N.": 1815.36
						},
						{
							"concepto": "Cargo por combustible tarifa 23.2 %",
							"costoSinImpuestos U.S. $": 19.66,
							"costoSinImpuestos Pesos M.N.": 421.07
						},
						{
							"concepto": "Seguro de envío (Protección del valor del envío)*",
							"costoSinImpuestos U.S. $": 100.0,
							"costoSinImpuestos Pesos M.N.": 2141.77
						},
						{
							"concepto": "Pago de impuestos en origen",
							"costoSinImpuestos U.S. $": 29.83,
							"costoSinImpuestos Pesos M.N.": 638.88
						}
					],
					"subTotal U.S. $": 234.25,
					"impuestos U.S. $": 9.37,
					"precioEstimadoTotal U.S. $": 243.62,
					"tipoDeCambio_": 21.4177,
					"subTotal Pesos M.N.": 5017.09,
					"impuestos Pesos M.N.": 200.68,
					"precioEstimadoTotal Pesos M.N.": 5217.78
				}
			]
		}
	],
	"error": null
}
Campo Tipo Descripción
facturacion Facturacion Información referente a las cuentas de facturación en S&G, Ir Cuentas facturación
desde Ciudad Información detallada del remitente
hasta Ciudad Información detallada del destinatario
detalles Datos paquete Detalle de fecha, descripción y dimensiones de los paquetes a enviar

Facturación

Campo Tipo Descripción
aliasCuenta Texto Cuenta asignada al centro de costo
productoDHL Texto Producto/Servicio DHL a consumir, Ir Productos DHL

Datos remitente

Campo Tipo Descripción
codigoPais Codigo Pais Información del remitente
codigoPostal Codigo postal Información del remitente

Datos destinatario

Campo Tipo Descripción
ciudad Ciudad de Destino Información del destinatario
codigoPais Codigo Pais Información del destinatario
codigoPostal Codigo postal Información del destinatario
nombrePais Nombre Pais Información del destinatario

Datos paquete

Campo Tipo Descripción
esInternaciona true Internacional
fechaDeEnvio Fecha YYYY-MM-DD Fecha en la que se realizará el envío
horaAlistamiento Hora HH:MM Hora en la que el envío estará listo
valorDeclarado Entero Monto declarado del contenido de la guía (opcional)
monedaValorDeclarado Texto Tipo de moneda
paquetes Array Paquete Información de los paquetes a enviar
pagoDelImpuestoPor Texto (S) Remitente, (D) Destinatario
montoAsegurado Entero Monto por el cual asegurar el contenido de la guía (opcional)
monedaMontoAsegurado Texto Tipo de moneda

Paquete

Campo Tipo Descripción
peso Decimal Datos del paquete
alto Entero Datos del paquete
ancho Entero Datos del paquete
largo Entero Datos del paquete

Cobertura

GET
cobertura

URL: https://shipandgoapps.com.mx:8090/api/v1/cobertura

Petición:


{
	"desde":{
		"codigoPais" : "MX", {# opcional #}
		"codigoPostal": "03800"
	},
	"hasta":{
		"codigoPais" : "MX", {# opcional #}
		"codigoPostal": "97000"
	},
	"detalles": {
		"esInternacional": false, {# opcional #}
		"fechaDeEnvio": "2022-01-30",
		"horaAlistamiento": "13:30",
		"paquetes": [
			{
				"peso": 4.141,
				"alto": 30, 
				"ancho": 30,
				"largo": 30
			}
		],
		"montoAsegurado" : 1, {# opcional #}
		"monedaMontoAsegurado" : "MXN" {# opcional #}
	}
}

Respuesta:


{
	"modo": "DESARROLLO",
	"datos": {
		"detalleCoberturas": {
			"cobertura": [
				{
					"areaOrigen": {
						"codigoArea": "MEX",
						"descripcion": null,
						"codigoEstacion": "RMX"
					},
					"areaDestino": {
						"codigoArea": "MID",
						"descripcion": null,
						"codigoEstacion": "MID"
					},
					"productoDHL": "N",
					"nombreProductoDHL": "EXPRESS DOMESTIC",
					"fechaDeRecoleccion": "2022-01-30",
					"horaLimiteRecoleccion": "PT19H",
					"horaReservacion": "PT19H",
					"diasEnTransito": 2,
					"diasDeRecoleccionAgregados": 0,
					"diasDeEntregaAgregados": 0,
					"codigoRecoleccionSinRepartidor": "",
					"codigoEntregaSinRepartidor": "",
					"fechaDeEntrega": {
						"fechaDeEntrega": "2022-02-01 11:59:00"
					},
					"horaDeEntrega": "PT23H59M",
					"pesoDimensional": 5.4,
					"unidadDePeso": "KG",
					"numeroDiaDeSemanaRecoleccion": 0,
					"numeroDiaDeSemanaEntrega": 2,
					"horaMasTempranaRecoleccion": "00:00:00",
					"horaMasTardeRecoleccion": "19:00:00"
				},
				{
					"areaOrigen": {
						"codigoArea": "MEX",
						"descripcion": null,
						"codigoEstacion": "RMX"
					},
					"areaDestino": {
						"codigoArea": "MID",
						"descripcion": null,
						"codigoEstacion": "MID"
					},
					"productoDHL": "G",
					"nombreProductoDHL": "ECONOMY SELECT DOMESTIC",
					"fechaDeRecoleccion": "2022-01-30",
					"horaLimiteRecoleccion": "PT19H",
					"horaReservacion": "PT19H",
					"diasEnTransito": 3,
					"diasDeRecoleccionAgregados": 0,
					"diasDeEntregaAgregados": 0,
					"codigoRecoleccionSinRepartidor": "",
					"codigoEntregaSinRepartidor": "",
					"fechaDeEntrega": {
						"fechaDeEntrega": "2022-02-02 11:59:00"
					},
					"horaDeEntrega": "PT23H59M",
					"pesoDimensional": 5.4,
					"unidadDePeso": "KG",
					"numeroDiaDeSemanaRecoleccion": 0,
					"numeroDiaDeSemanaEntrega": 3,
					"horaMasTempranaRecoleccion": "00:00:00",
					"horaMasTardeRecoleccion": "19:00:00"
				}
			]
		}
	},
	"error": null
}
Campo Tipo Descripción
desde Datos persona Información detallada del remitente
hasta Datos persona Información detallada del destinatario
detalles Datos paquete Detalle de fecha, descripción y dimensiones de los paquetes a enviar

Datos persona

Campo Tipo Descripción
codigoPais Codigo Pais Información referente a la facturación, consultarla con S&G
codigoPostal Codigo postal Información detallada del destinatario

Datos paquete

Campo Tipo Descripción
esInternacional Booleano (false) Nacional (True)
fechaDeEnvio Fecha YYYY-MM-DD Fecha en que se realizará el envío
horaAlistamiento Hora HH:MM Hora en la que el envío estará listo
paquetes Array Paquete Información de los paquetes a enviar
montoAsegurado Entero Monto por el cual asegurar el contenido de la guía (opcional)
monedaMontoAsegurado Texto Tipo de moneda

Paquete

Campo Tipo Descripción
peso Decimal Datos del paquete
alto Entero Datos del paquete
ancho Entero Datos del paquete
largo Entero Datos del paquete

Recolección

POST
Recoleccion

URL: https://shipandgoapps.com.mx:8090/api/v1/Recoleccion

Petición:


{
   "lugarRecoleccion":{
      "tipoUbicacion":"R",
      "lugarUbicacion":"En entrada de la casa",
      "instruccionesEspeciales": "al final de la entrada",
      "nombreCompania":"prueba",
      "lineaDireccion1":"prueba 22",
      "lineaDireccion2":"Aldama Tetln",
      "ubicacionFisicaPaquete":".",
      "codigoPostal":"44820"
   },
   "detallesRecoleccion":{
      "numeroDeGuia":"1177350506",
      "fechaRecoleccion":"2023-09-25",
      "horaPaqueteListo":"12:53",
      "horaLimiteRecoleccion":"16:53"
   },
   "contactoRecoleccion":{
      "nombre":"prueba de origen",
      "telefono":"3312312312"
   }
}

Respuesta:


 {
	"modo": "DESARROLLO",
	"datos": {
		"folioRecoleccion": "CBJ180121002626",
		"Consideraciones": "En caso de que Dhl no pueda hacer la recolección, se deberá realizar nuevamente el proceso de solicitud de recolección en el siguiente día hábil, gracias",
		"GuiasProcesadas": "1"
	},
	"error": null
}
Campo Tipo Descripción
lugarRecoleccion Datos lugar de recolección Información detallada del destinatario
numeroDeGuia Datos paquete Información detallada del destinatario
detallesRecoleccion Datos detalle de recolección Información detallada del destinatario
contactoRecoleccion Datos contacto recolección Información detallada del destinatario

Nota 1: DHL permite las recolecciones como hora limite de recolección 06:00pm, con al menos 1 hora de diferencia entre paquete listo y hora limite de recolección.

Nota 2: DHL no realiza recolecciones en fines de semana ni días festivos, si por alguna motivo programas una recolección en fin de semana, se reprogramara para el próximo dia hábil

Datos lugar de recolección

Campo Tipo Descripción
tipoUbicacion Texto Información de lugar de recolección:
R - Residencia
B - Negocio (Business)
lugarUbicacion Donde se recogerá físicamente el paquete Información detallada del destinatario
instruccionesEspeciales Detalles adicionales de la recolección (max 80 caracteres) Información detallada del destinatario
nombreCompania Texto Nombre de la compañía
lineaDireccion1 Texto Dirección del lugar de la recolección
lineaDireccion2 Texto Dirección del lugar de la recolección
ubicacionFisicaPaquete Texto Lugar de la recolección
codigoPostal Codigo postal Información del lugar de recolección

Datos detalle de recolección

Campo Tipo Descripción
numeroDeGuia 1177350506 Número de guia
fechaRecoleccion Fecha YYYY-MM-DD Fecha de recolección
horaPaqueteListo Hora HH:MM Hora en la que el envío estará listo
horaLimiteRecoleccion Hora HH:MM Hora límite de la recolección (3 horas posteriores a la horaPaqueteListo)

Datos contacto recolección

Campo Tipo Descripción
nombre Texto Datos del contacto de recolección
teléfono Texto Datos del contacto de recolección

Datos paquete

Campo Tipo Descripción
cuentaFacturacion espacio en blanco Datos del paquete
numeroDeGuia Texto Número de guía del paquete
paquetes Array Paquete Información de los paquetes a enviar

Paquete

Campo Tipo Descripción
peso Decimal Datos del paquete
alto Entero Datos del paquete
ancho Entero Datos del paquete
largo Entero Datos del paquete

Cancelar recolección

DELETE
recoleccion

URL: https://shipandgoapps.com.mx:8090/api/v1/recoleccion

Petición:


    {
    "folioACancelar": "CBJ180121002626",
    "nombreQuienCancela": "Lorem Ipsum",
    "razonCancelacion": "Prueba cancelación"
    }

Respuesta:


{
    "modo": "PRODUCCION",
    "datos": {
        "FolioRecoleccion": "AME240111123456",
        "mensaje": "Recolección cancelada exitosamente"
    },
    "error": null
}
Campo Tipo Descripción
folioACancelar Texto Folio de la recolección que se pretende cancelar
nombreQuienCancela Texto Nombre informativo de quien está solicitando la cancelación
razonCancelacion Texto Razón por la cual se solicita la cancelación