DOCS

Ligar a conta de transportadora DHL

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

Introdução 

O processo de ligação da conta de transportadora DHL valida as suas credenciais e garante que a sua conta está corretamente configurada para obter tarifas e gerar etiquetas de envio. Quando liga a sua conta DHL, a Zonos efetua uma chamada de tarifação de teste para verificar se a ligação está a funcionar corretamente antes de guardar as suas credenciais.

Para se registar na DHL Express ou efetuar a configuração através do seu Zonos Dashboard, siga os passos deste guia.

Como funciona a ligação da conta de transportadora DHL 

Ao ligar a sua conta de transportadora DHL:

  • Valida que forneceu os tipos de credenciais corretos para a DHL
  • Efetua uma chamada de tarifação em tempo real à API da DHL para confirmar que as credenciais são válidas
  • Guarda a sua conta ligada na Zonos para futuras tarifações de envios e criação de etiquetas
  • Devolve os detalhes da conta ligada, incluindo as informações da sua conta DHL e o tipo de tarifa

Depois de ligada, a sua conta de transportadora DHL pode ser utilizada para obter tarifas de envio em tempo real com base nas suas tarifas negociadas (se aplicável) e para criar etiquetas de envio DHL.

Ligar a sua conta DHL 

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

Mutação

Utilize esta mutação para ligar a sua conta de transportadora 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 transportadora DHL, o tipo de tarifa e as credenciais da sua conta 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}

A DHL requer os seguintes tipos de credenciais:

  • API_KEY - A sua chave de API da DHL
  • API_PASSWORD - A sua palavra-passe de API da DHL
  • ACCOUNT_NUMBER - O seu número de conta DHL

Pode encontrar estas credenciais no portal da sua conta DHL ou contactando o seu representante de conta DHL.

Exemplos de resposta

Ligação bem-sucedida

Quando as credenciais são válidas e a DHL devolve tarifas com êxito:

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 credencial não suportado

Se fornecer um tipo de credencial que a 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 forem válidos, mas não se autenticarem com êxito na 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 acontece após a ligação

Depois de a sua conta de transportadora DHL ser ligada com êxito:

  • A conta fica guardada na sua organização e associada às suas credenciais
  • Pode obter tarifas de envio DHL utilizando as suas tarifas negociadas (quando aplicável)
  • Pode criar etiquetas de envio DHL através da API da Zonos
  • A conta de transportadora pode ser utilizada em vários envios sem ser necessário voltar a ligá-la

Próximos passos 

Depois de ligar a sua conta de transportadora DHL:

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

Esta página foi útil?