DOCS

Integrar API de envio

Entrar
Agendar uma demonstração
Landed Cost•
InícioPara provedores de logística Landed Cost Integrar API de envio

Criar Zonos envios a partir da sua plataforma

Dê aos clientes a capacidade de criar envios e etiquetas Zonos a partir da sua plataforma.

Se você é uma plataforma de envio que suporta clientes Zonos enviando internacionalmente, integrar-se ao Zonos para a criação de envios deve ser uma consideração principal. Isso permitirá que você ofereça a experiência mais fluida para seus comerciantes e seus clientes, aproveitando os recursos existentes da sua plataforma enquanto deixa o Zonos gerenciar a criação do envio, etiqueta e documentação aduaneira de suporte.

As vantagens de usar Zonos para criar envios incluem:

  • Cobrança de terceiros de impostos e taxas - Garantiremos que o número da conta do transportador do seu comerciante ou seu seja usado para as taxas de envio, enquanto as contas de impostos e taxas vão para o Zonos.
  • Flexibilidade - Em vez de realizar trabalho de desenvolvimento para garantir que você possa gerar etiquetas compatíveis com sua plataforma, integre-se à nossa API e deixe a conformidade em constante mudança de comércio internacional conosco.
  • Documentação aduaneira precisa - Quando você usa Zonos para gerar etiquetas, garantimos que os detalhes corretos sejam passados para o transportador para garantir que o pacote passe pela alfândega rapidamente.

Este guia irá orientá-lo através das etapas para implementar uma integração completa de ponta a ponta que permitirá que você chame o Zonos para envios a partir da sua plataforma.

Permitir que os clientes imprimam etiquetas Zonos a partir da sua plataforma 

Siga as etapas abaixo para permitir que seus clientes recuperem etiquetas Zonos a partir da sua plataforma.

1

Permitir que os clientes insiram suas credenciais da API Zonos

A Zonos API é acessível por um credentialToken. Sua plataforma precisará dar aos clientes a capacidade de inserir seu credentialToken do Zonos Dashboard na sua plataforma. A partir daqui, você poderá fazer solicitações ao Zonos em nome deles.

2

Criar um envio

Para recuperar uma label, você precisa criar um shipment com o qual a label estará associada. O Zonos gerencia esse processo com um fluxo de trabalho que cria shipments e labels na mesma solicitação. Ao realizar essa mutação, você não precisa passar um serviceLevel, pois usaremos o serviceLevel utilizado no landedCost que está vinculado ao order. Para o orderId, você pode usar o ID do pedido Zonos ou o accountOrderNumber que provavelmente já estará em seu sistema. Quando um envio e etiquetas forem criados com sucesso, retornaremos etiquetas como uma labelImage, que é uma BASE64_ENCODED_IMAGE, ou como uma url de onde a etiqueta pode ser recuperada.

Mutação

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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
mutation {
  partyCreateWorkflow(
    input: [
      {
        location: {
          administrativeArea: "Utah"
          administrativeAreaCode: "UT"
          countryCode: US
          line1: "123 Test Street"
          locality: "St George"
          postalCode: "84770"
        }
        person: {
          companyName: "test Corp"
          phone: "8018565714"
          firstName: "Tom"
        }
        type: ORIGIN
      }
      {
        location: {
          administrativeArea: "Quebec"
          administrativeAreaCode: "QC"
          countryCode: CA
          line1: "2147 Pitfield Blvd"
          locality: "Pierrefonds"
          postalCode: "H9H 3C7"
        }
        person: {
          email: "test@gmail.com"
          firstName: "firstName"
          lastName: "lastName"
          phone: "5022303021"
          companyName: "goProTest"
        }
        type: DESTINATION
      }
    ]
  ) {
    type
    id
    organization
  }
  itemCreateWorkflow(
    input: [
      {
        amount: 50
        currencyCode: USD
        countryOfOrigin: US
        quantity: 1
        metadata: { key: "tags", value: "accessory" }
        sku: "ow-accessory-gtr"
        productId: "1892949164056"
      }
    ]
  ) {
    amount
    id
    quantity
    sku
    productId
  }
  cartonsCreateWorkflow(
    input: {
      dimensionalUnit: INCH
      height: "5"
      length: "5"
      weight: "5"
      weightUnit: POUND
      width: "10"
    }
  ) {
    items {
      item {
        amount
        id
        quantity
        sku
      }
    }
    length
    width
    weight
    weightUnit
    height
    id
  }
  shipmentCreateWorkflow(
    input: { orderId: "order_f648793c-2585-4684-afa0-da1fdb0d4f94" }
  ) {
    id
    serviceLevel {
      id
      name
      carrier {
        id
        name
      }
    }

    shipmentCartons {
      id
      tracking {
        number
      }
      label {
        labelImage
        labelFileType
      }
      carton {
        id
        width
        length
        height
        weight
        items {
          item {
            id
            amount
            description
          }
        }
      }
    }
    customsDocuments {
      id
      fileType
      fileUrl
    }
  }
}

Resposta

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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
  "data": {
    "shipmentCreateWorkflow": {
      "id": "shipment_90f3c62a-c50e-466c-a317-70ececb26dc4",
      "serviceLevel": {
        "id": "service_level_a7129244-7334-4e8b-8b10-6494b0e49a7d",
        "name": "UPS Worldwide Express",
        "carrier": {
          "id": "carrier_26bf7275-cac2-47b5-979a-4325fa2efa82",
          "name": "UPS"
        }
      },
      "shipmentCartons": [
        {
          "id": "shipment_carton_d254a6df-9dcd-47fc-926b-48eaeaea232c",
          "tracking": {
            "number": "1Z2030216698896462"
          },
          "label": {
            "labelImage": "{{BASE64_ENCODED_IMAGE}}",
            "labelFileType": "PDF",
            "labelAmounts": [
              {
                "amount": 41.88,
                "amountType": "QUOTE"
              }
            ]
          },
          "carton": {
            "id": "carton_0jhg9mxk431q7",
            "width": 10.0,
            "length": 5.0,
            "height": 5.0,
            "weight": 5.0,
            "items": [
              {
                "item": {
                  "id": "item_0jhg9mxdwm77w",
                  "amount": 50,
                  "description": null
                }
              }
            ]
          }
        }
      ],
      "customsDocuments": [
        {
          "id": "customs_doc_d8bedf7a-2de0-4729-8bdd-ebd901b67127",
          "fileType": "PDF",
          "fileUrl": "https://prod-zonos-shipping-label.s3.us-east-2.amazonaws.com/organization_a61090a2-d18b-415c-9870-03b9087cbf2d/shipment_90f3c62a-c50e-466c-a317-70ececb26dc4/customs/International_Forms.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250117T231615Z&X-Amz-SignedHeaders=host&X-Amz-Credential=AKIAR3GS2GP6V4LZE3OI%2F20250117%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Expires=14400&X-Amz-Signature=6c17e358a038c3cd7d61391302909ee503344249405974e490d9b46051c79dba"
        }
      ]
    }
  }
}
3

Anular um envio

No caso de um cliente querer anular um envio, você pode usar a seguinte mutação que irá anular todos os rótulos vinculados ao envio.

Solicitação

1
2
3
4
5
6
7
8
9
10
11
12
mutation {
  shipmentStatusUpdate(
    input: {
      shipment: "shipment_f1fe4dbd-e471-49fa-94e7-84e369083223"
      status: VOIDED
      note: "Voiding shipment"
    }
  ) {
    id
    status
  }
}

Esta página foi útil?

Agendar uma demonstração

Dúvidas?

Obter suporte
© 2025 Zonoszonos.com
Nesta página:
  • Criar Zonos envios a partir da sua plataforma
  • Permitir que os clientes imprimam etiquetas Zonos a partir da sua plataforma
  • Permitir que os clientes insiram suas credenciais da API Zonos
  • Criar um envio
  • Anular um envio