DOCS

Conectar via API

Conectar Conta de Transporte DHL

Conecte de forma segura sua conta de transporte DHL para acessar tarifas negociadas de envio e criar etiquetas diretamente através do Zonos.

Comece agora 

O processo de conexão da conta de transporte DHL valida suas credenciais e garante que sua conta esteja configurada corretamente para recuperar tarifas e gerar etiquetas de envio. Quando você conecta sua conta DHL, o Zonos realiza uma chamada de avaliação de teste para verificar se a conexão está funcionando corretamente antes de armazenar suas credenciais.

Para se registrar na DHL Express ou configurar através do seu Zonos Painel, siga os passos neste guia.

Como funciona a conexão da conta de transporte DHL 

Conectar sua conta de transporte DHL:

  • Valida se você forneceu os tipos corretos de credenciais para a DHL
  • Realiza uma chamada de avaliação ao vivo na API da DHL para confirmar se as credenciais são válidas
  • Armazena sua conta conectada no Zonos para futuras avaliações de remessas e criação de etiquetas
  • Retorna os detalhes da conta conectada, incluindo suas informações de conta DHL e o tipo de rate

Após a conexão, sua conta de transporte DHL pode ser usada para obter tarifas de envio em tempo real com base nas tarifas negociadas (se aplicável) e criar etiquetas de envio DHL.

Conecte sua conta DHL 

Use a mutação carrierAccountConnect para conectar sua conta de transporte DHL com suas credenciais.

Mutação

Use esta mutação para conectar sua conta de transporte DHL e validar suas credenciais.

MUTAÇÃO

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
      }
    }
  }
}

Variáveis

A mutação requer o código da transportadora DHL, rate tipo, e as credenciais da sua conta DHL.

VARIÁVEIS

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 requer os seguintes tipos de credenciais:

  • API_KEY - Sua chave de API DHL
  • API_PASSWORD - Sua senha de API DHL
  • ACCOUNT_NUMBER - Seu número de conta DHL

Você pode encontrar essas credenciais no portal da sua conta DHL ou entrando em contato com o representante da sua conta DHL.

Exemplos de Resposta

Conexão bem-sucedida

Quando as credenciais forem válidas e a DHL retornar as tarifas com sucesso:

RESPOSTA

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"
          }
        ]
      }
    }
  }
}

Erro: Tipo de credencial não suportado

Se você fornecer um tipo de credencial que a DHL não suporta:

ERRO

json

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

Erro: Credenciais inválidas

Se as credenciais forem válidas, mas não se autenticarem com sucesso na DHL:

ERRO

json

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

O que acontece após a conexão

Assim que a sua conta de transportadora DHL for conectada com sucesso:

  • A conta fica armazenada na sua organização e vinculada às suas credenciais
  • Você pode recuperar tarifas de envio DHL usando suas tarifas negociadas (quando aplicável)
  • Você pode criar etiquetas de envio DHL através da Zonos API
  • A conta de transportadora pode ser usada em várias remessas sem reconectar

Próximos passos 

Depois de conectar sua conta de transportadora DHL:

Esta página foi útil?