DOCS

Ligar via API

Ligar a conta de transportador DHL

Ligue de forma segura a sua conta de transportador DHL para aceder a tarifas de envio negociadas e criar etiquetas diretamente através de Zonos.

Primeiros passos 

O processo de conexão da conta de transportador DHL valida as suas credenciais e garante que a sua conta está configurada corretamente para obter tarifas e gerar etiquetas de envio. Quando você liga a sua conta de DHL, Zonos realiza uma chamada de teste de tarifação para verificar que a conexão funciona corretamente antes de armazenar suas credenciais.

Para se registrar em DHL Express ou se configurar através do seu Zonos Dashboard, siga os passos deste guia.

Como funciona a conexão de conta de transportador DHL 

Ao ligar a sua conta de transportador DHL:

  • É validado que você tenha fornecido os tipos de credenciais corretos para DHL
  • É feita uma chamada de tarifação em tempo real para a API de DHL para confirmar que as credenciais são válidas
  • A sua conta é armazenada conectada em Zonos para futuras avaliações de envio e criação de etiquetas
  • São devolvidos os detalhes da conta ligada, incluindo as suas informações de conta DHL e o tipo de tarifa

Uma vez ligada, a sua conta de transportador DHL pode ser utilizada para obter tarifas de envio em tempo real baseadas nas suas tarifas negociadas (se aplicável) e criar rótulos de envio de DHL.

Ligue a sua conta de DHL 

Use a mutação carrierAccountConnect para ligar a sua conta de transportador DHL com as suas credenciais.

Mutação

Use esta mutação para ligar a sua conta de transportador DHL e validar as suas credenciais.

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

Variáveis

A mutação requer o código de transportador DHL, o tipo de tarifa e as credenciais da sua conta de DHL.

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

DHL requer os seguintes tipos de credenciais:

  • API_KEY - Seu API key de DHL
  • API_PASSWORD - Seu API password de DHL
  • ACCOUNT_NUMBER - Seu account number de DHL

Você pode encontrar essas credenciais no portal da sua conta de DHL ou contactar o seu representante de conta DHL.

Exemplos de resposta

Conexão correta

Quando as credenciais são válidas e DHL devolve tarifas corretamente:

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

Erro: tipo de cartão não compatível

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

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

Erro: credenciais inválidas

Se os tipos de credenciais são válidos, mas não são autenticadas corretamente com DHL:

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

O que ocorre após a conexão

Uma vez ligada corretamente a sua conta de transportador DHL:

  • A conta é armazenada em sua organização e vincula-se às suas credenciais
  • Você pode obter tarifas de envio de DHL utilizando as suas tarifas negociadas (quando aplicar)
  • Você pode criar etiquetas de envio de DHL através da API de Zonos
  • A conta de transportador pode ser utilizada em várias remessas sem voltar a ligar

Próximos passos 

Após ligar a sua conta de transportador DHL:

GraphQL API ReferenceTypes, inputs, and operations used in this guide

Esta página foi útil?