DOCS

Integrate label api

/

Tạo Zonos vận chuyển từ nền tảng của bạn

Cung cấp cho khách hàng khả năng tạo Zonos vận chuyển và nhãn từ nền tảng của bạn.

Nếu bạn là một nền tảng vận chuyển hỗ trợ khách hàng Zonos vận chuyển quốc tế, việc kết nối với Zonos để tạo vận chuyển nên là một ưu tiên hàng đầu. Điều này sẽ cho phép bạn cung cấp trải nghiệm liền mạch nhất cho các thương nhân và khách hàng của họ bằng cách tận dụng các tính năng hiện có của nền tảng của bạn trong khi để Zonos quản lý việc tạo vận chuyển, nhãn và tài liệu hải quan hỗ trợ.

Lợi ích của việc sử dụng Zonos để tạo vận chuyển bao gồm:

  • Thanh toán thuế và phí từ bên thứ ba - Chúng tôi sẽ đảm bảo rằng số tài khoản của bạn hoặc của thương nhân được sử dụng cho các khoản phí vận chuyển trong khi hóa đơn cho thuế và phí sẽ đến Zonos.
  • Tính linh hoạt - Thay vì thực hiện công việc phát triển để đảm bảo rằng bạn có thể tạo nhãn tuân thủ với nền tảng của mình, hãy tích hợp với API của chúng tôi và để chúng tôi quản lý sự tuân thủ xuyên biên giới đang thay đổi.
  • Tài liệu hải quan chính xác - Khi bạn sử dụng Zonos để tạo nhãn, chúng tôi đảm bảo rằng các chi tiết đúng được chuyển đến nhà vận chuyển để đảm bảo rằng gói hàng được thông quan nhanh chóng.

Hướng dẫn này sẽ hướng dẫn bạn qua các bước để thực hiện một tích hợp hoàn chỉnh từ đầu đến cuối cho phép bạn gọi Zonos để vận chuyển từ nền tảng của bạn.

Cho phép khách hàng in nhãn Zonos từ nền tảng của bạn 

Thực hiện theo các bước dưới đây để cho phép khách hàng của bạn lấy nhãn Zonos từ nền tảng của bạn.

1

Cho phép khách hàng nhập thông tin xác thực API Zonos

Zonos API có thể truy cập bằng credentialToken. Nền tảng của bạn sẽ cần cung cấp cho khách hàng khả năng nhập credentialToken của họ từ Zonos Dashboard vào nền tảng của bạn. Từ đây, bạn sẽ có thể thực hiện các yêu cầu đến Zonos thay mặt cho họ.

2

Tạo một vận chuyển

Để lấy một label, bạn cần tạo một shipmentlabel sẽ được liên kết với. Zonos quản lý quy trình này với một quy trình làm việc tạo shipmentslabels trong cùng một yêu cầu. Khi thực hiện biến đổi này, bạn không cần phải truyền một serviceLevel vì chúng tôi sẽ sử dụng serviceLevel được sử dụng từ landedCost liên kết với order. Đối với orderId, bạn có thể sử dụng ID đơn hàng Zonos hoặc accountOrderNumber mà có thể đã có trong hệ thống của bạn. Khi một vận chuyển và nhãn được tạo thành công, chúng tôi sẽ trả về nhãn dưới dạng labelImage là một BASE64_ENCODED_IMAGE, hoặc dưới dạng url nơi nhãn có thể được lấy từ đó.

Biến đổi

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

Phản hồi

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

Hủy lô hàng

Trong trường hợp khách hàng muốn hủy lô hàng, bạn có thể sử dụng mutation sau đây để hủy tất cả các nhãn liên quan đến lô hàng.

Yêu cầu

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

Trang này có hữu ích không?