DOCS

Conexión vía API

Conectar cuenta de DHL

Conecta de manera segura tu cuenta de DHL para acceder a tarifas negociadas y crear etiquetas directamente a través de Zonos.

Comenzar 

El proceso de conexión de la cuenta de DHL valida tus credenciales y asegura que tu cuenta esté correctamente configurada para obtener tarifas y generar etiquetas de envío. Cuando conectas tu cuenta de DHL, Zonos realiza una llamada de prueba para verificar que la conexión funciona correctamente antes de almacenar tus credenciales.

Para registrarte en DHL Express o configurarlo a través de tu Zonos Panel de control, sigue los pasos en esta guía.

Cómo funciona la conexión de la cuenta de DHL 

Conectar tu cuenta de DHL:

  • Valida que hayas proporcionado los tipos de credenciales correctos para DHL
  • Realiza una llamada de tarifa en vivo a la API de DHL para confirmar que las credenciales son válidas
  • Almacena tu cuenta conectada en Zonos para futuras tarifas de envío y creación de etiquetas
  • Devuelve los detalles de la cuenta conectada, incluyendo la información de tu cuenta DHL y el tipo de rate

Una vez conectada, tu cuenta de DHL puede usarse para obtener tarifas de envío en tiempo real basadas en tus tarifas negociadas (si aplica) y crear etiquetas de envío DHL.

Conecta tu cuenta de DHL 

Utiliza la mutación carrierAccountConnect para conectar tu cuenta de DHL con tus credenciales.

Mutación

Utiliza esta mutación para conectar tu cuenta de DHL y validar tus credenciales.

MUTACIÓN

GraphQL

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
mutation CarrierAccountConnect($input: CarrierAccountConnectInput!) {
  carrierAccountConnect(input: $input) {
    errors
    carrierAccount {
      credentialProvider
      id
      integrationType
      organization
      rateType
      carrier {
        id
        code
        name
      }
      credentials {
        type
        value
      }
    }
  }
}

Variables

La mutación requiere el código de transportista DHL, rate tipo, y tus credenciales de la cuenta DHL.

VARIABLES

json

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "input": {
    "carrierCode": "DHL",
    "rateType": "NEGOTIATED",
    "credentials": [
      {
        "type": "API_KEY",
        "value": "actual_api_key_value"
      },
      {
        "type": "API_PASSWORD",
        "value": "actual_api_password_value"
      },
      {
        "type": "ACCOUNT_NUMBER",
        "value": "actual_account_number_value"
      }
    ]
  }
}

DHL requiere los siguientes tipos de credenciales:

  • API_KEY - Su clave API de DHL
  • API_PASSWORD - Su contraseña API de DHL
  • ACCOUNT_NUMBER - Su número de cuenta DHL

Puede encontrar estas credenciales en su portal de cuenta DHL o contactando a su representante de cuenta DHL.

Ejemplos de respuesta

Conexión exitosa

Cuando las credenciales sean válidas y DHL devuelva tarifas con éxito:

RESPUESTA

json

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
  "data": {
    "carrierAccountConnect": {
      "errors": [],
      "carrierAccount": {
        "credentialProvider": "ORGANIZATION",
        "id": "carrier_account_123",
        "integrationType": "REST",
        "organization": "organization_id",
        "rateType": "NEGOTIATED",
        "carrier": {
          "id": "carrier_123",
          "code": "dhl",
          "name": "DHL"
        },
        "credentials": [
          {
            "type": "API_KEY",
            "value": "actual_api_key_value"
          },
          {
            "type": "API_PASSWORD",
            "value": "actual_api_password_value"
          },
          {
            "type": "ACCOUNT_NUMBER",
            "value": "actual_account_number_value"
          }
        ]
      }
    }
  }
}

Error: tipo de credencial no soportado

Si se proporciona un tipo de credencial que DHL no admite:

ERROR

json

1
2
3
4
5
6
7
8
{
  "data": {
    "carrierAccountConnect": {
      "errors": ["Credential type SITE_ID is not supported by carrier DHL"],
      "carrierAccount": null
    }
  }
}

Error: credenciales inválidas

Si las credenciales son de tipos válidos pero no se autentican con éxito con DHL:

ERROR

json

1
2
3
4
5
6
7
8
{
  "data": {
    "carrierAccountConnect": {
      "errors": ["Failed to get rating from DHL API"],
      "carrierAccount": null
    }
  }
}

¿Qué sucede después de la conexión?

  • La cuenta se almacena en tu organización y está vinculada a tus credenciales
  • Puedes recuperar las tarifas de envío DHL utilizando tus tarifas negociadas (cuando corresponda)
  • Puedes crear etiquetas de envío DHL a través de la Zonos API
  • La cuenta del transportista puede usarse en múltiples envíos sin volver a conectarla

Siguientes pasos 

¿Fue útil esta página?