DOCS

Integrate label api

/

Buat pengiriman Zonos dari platform Anda

Beri pelanggan kemampuan untuk membuat pengiriman dan label Zonos dari platform Anda.

Jika Anda adalah platform pengiriman yang mendukung pelanggan Zonos yang mengirim secara internasional, menghubungkan ke Zonos untuk pembuatan pengiriman harus menjadi pertimbangan utama. Ini akan memungkinkan Anda untuk menawarkan pengalaman yang paling mulus bagi pedagang dan pelanggan mereka dengan memanfaatkan fitur-fitur yang ada di platform Anda sambil membiarkan Zonos mengelola pembuatan pengiriman, label, dan dokumentasi bea cukai yang mendukung.

Keuntungan menggunakan Zonos untuk membuat pengiriman meliputi:

  • Penagihan pihak ketiga untuk bea dan pajak - Kami akan memastikan bahwa nomor akun pengangkut Anda atau pedagang Anda digunakan untuk biaya pengiriman sementara tagihan untuk bea dan pajak datang ke Zonos.
  • Fleksibilitas - Alih-alih melakukan pekerjaan pengembangan untuk memastikan bahwa Anda dapat menghasilkan label yang sesuai dengan peraturan dengan platform Anda, integrasikan dengan API kami dan biarkan kepatuhan lintas batas yang selalu berubah menjadi tanggung jawab kami.
  • Dokumentasi bea cukai yang akurat - Ketika Anda menggunakan Zonos untuk menghasilkan label, kami memastikan bahwa detail yang tepat disampaikan kepada pengangkut untuk memastikan bahwa paket melewati bea cukai dengan cepat.

Panduan ini akan memandu Anda melalui langkah-langkah untuk menerapkan integrasi lengkap dari awal hingga akhir yang akan memungkinkan Anda untuk memanggil Zonos untuk pengiriman dari platform Anda.

Aktifkan pelanggan untuk mencetak label Zonos dari platform Anda 

Ikuti langkah-langkah di bawah ini untuk memungkinkan pelanggan Anda mengambil label Zonos dari platform Anda.

1

Izinkan pelanggan untuk memasukkan kredensial API Zonos

Zonos API dapat diakses dengan credentialToken. Platform Anda perlu memberikan kemampuan kepada pelanggan untuk memasukkan credentialToken mereka dari Zonos Dashboard ke dalam platform Anda. Dari sini, Anda akan dapat melakukan permintaan ke Zonos atas nama mereka.

2

Buat pengiriman

Untuk mengambil label, Anda diharuskan untuk membuat shipment yang akan dikaitkan dengan label. Zonos mengelola proses ini dengan alur kerja yang membuat shipments dan labels dalam permintaan yang sama. Saat melakukan mutasi ini, Anda tidak perlu mengirimkan serviceLevel karena kami akan menggunakan serviceLevel yang digunakan dari landedCost yang terkait dengan order. Untuk orderId, Anda dapat menggunakan ID pesanan Zonos atau accountOrderNumber yang kemungkinan sudah ada di sistem Anda. Ketika pengiriman dan label berhasil dibuat, kami akan mengembalikan label sebagai labelImage yang merupakan BASE64_ENCODED_IMAGE, atau sebagai url di mana label dapat diambil.

Mutasi

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
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" }
        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"
          metadata: { key: "key", value: "value" }
        }
        type: DESTINATION
      }
    ]
  ) {
    type
    id
    organization
  }
  itemCreateWorkflow(
    input: {
      amount: "50"
      currencyCode: USD
      quantity: 1
      sku: "test1"
      description: "shoes"
      hsCode: "670121"
    }
  ) {
    amount
    id
    sku
  }
  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_627db90e-d2e2-4499-b388-bfd5d8d33e18" }
  ) {
    id
    status
    shipmentCartons {
      id
      label {
        id
        url
        labelAmounts {
          amount
          amountType
        }
      }
    }
    customsDocuments {
      id
      fileType
      fileUrl
    }
  }
}

Respon

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
{
  "data": {
    "shipmentCreateWorkflow": {
      "id": "shipment_cd535d6f-c92a-41a9-ae70-f6e67ed30dc9",
      "status": "CREATED"
    },
    "shipmentCartons": [
      {
        "id": "label_171c7cf5-b005-45cb-bac4-2bfc141dbacb",
        "trackingNumber": "794602938880",
        "status": "CREATED",
        "documentFiling": "ELECTRONIC",
        "labelImage": "{{BASE64_ENCODED_IMAGE}}",
        "labelAmounts": [
          {
            "amount": 137.87,
            "amountType": "QUOTE"
          }
        ],
        "shipmentCarton": "shipment_carton_480d776e-48d8-4699-9b37-bc26c7d0cd1b",
        "statusTransitions": [
          {
            "changedAt": "2024-02-09T18:54:37.158Z",
            "note": "Label created",
            "status": "CREATED"
          }
        ]
      }
    ]
  }
}
3

Batalkan pengiriman

Dalam hal seorang pelanggan ingin membatalkan pengiriman, Anda dapat menggunakan mutasi berikut yang akan membatalkan semua label yang terkait dengan pengiriman.

Permintaan

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

Apakah halaman ini membantu?