通過 API 建立貨運單據
在計算完著陸成本並建立訂單後,您可以通過 API 向 Zonos 發送追蹤編號和其他貨運單據詳情。
當您為現有訂單建立貨運單據且不需要修改項目或單位詳情時,請使用此工作流程。它支持可選的追蹤編號、履約中心、服務級別選擇和宣告價值保險。
1
mutation CreateShipment($input: ShipmentCreateWorkflowInput!) {2
shipmentCreateWorkflow(input: $input) {3
id4
status5
trackingDetails {6
number7
}8
serviceLevel {9
id10
name11
carrier {12
id13
name14
}15
}16
shipmentCartons {17
id18
carton {19
id20
width21
length22
height23
weight24
items {25
item {26
id27
amount28
description29
}30
}31
}32
label {33
url34
trackingNumber35
id36
documentFiling37
}38
}39
}40
}變量選項:
- 含履約中心: 添加
"fulfillmentCenter": "fulfillment_center_12345"以指定原點位置 - 含自訂追蹤: 設置
"generateLabel": false並添加"trackingNumbers": ["tracking_1", "tracking_2"] - 含服務級別: 添加
"serviceLevel": "dhl.express_example"以選擇特定的運送商服務 - 含宣告價值保險: 添加
"isDeclaredValue": true以啟用宣告價值保障
宣告價值
設置 "isDeclaredValue": true 以為貨運單據中的所有項目啟用宣告價值保障。Zonos 自動宣告訂單中提交的所有項目的全部價值;商戶無法修改此金額。這設定了運送商在運輸過程中遺失、損壞或被盜時將接受的最大賠償責任。此功能僅支持 UPS、FedEx 和 DHL 貨運。Zonos 在您啟用宣告價值時自動處理特定於運送商的實現,包括對這些運送商的 API 呼叫中的適當參數,因此您無需管理不同的運送商要求。
UPS 限制:UPS 只涵蓋 100.01-50,000 美元之間的價值,並在紙箱層級處理宣告價值。對於多紙箱貨運,商戶必須分割貨運以指定每個紙箱的保障。UPS 還為超過 999 美元的宣告價值產生一份額外的保險表單(UPS Control Log),必須與標籤一起列印。
FedEx 和 DHL:在貨運層級處理宣告價值,無額外限制。
特殊服務
在紙箱上使用 specialServices 以指示電池、乾冰、危險品或簽名要求的特殊處理需求。請查看 特殊服務指南 以了解完整詳情和示例。
作廢貨運單據
若要取消已建立的標籤,請使用以下 mutation 作廢貨運單據。任何相關聯的標籤也將自動作廢。請注意,一旦貨運單據被作廢,就無法更新或還原。
1
mutation {2
shipmentStatusUpdate(3
input: {4
shipment: "shipment_12345678-1234-1234-1234-123456789stu"5
status: VOIDED6
note: "Voiding shipment"7
}8
) {9
id10
status11
}12
}GraphQL API ReferenceTypes, inputs, and operations used in this guide
為現有訂單建立貨運單據
使用 Zonos API 在計算完著陸成本並建立訂單後,建立貨運單據和標籤。
GraphQL
本指南適用於已整合 Zonos API 且需要為系統中現有訂單建立貨運單據的用戶。如果您是一個運送平台,希望向客戶提供 Zonos 貨運單據建立功能,請查看我們的 Shipment API 指南。
如果您已整合 Zonos API 並獲得批准 在 Dashboard 之外進行運送,請使用
shipmentCreateWorkflowmutation 建立貨運單據並提供追蹤資訊。這些 mutations 還允許您告知 Zonos 關於國內運送至交叉轉運設施的信息。注意: 如果您使用的 Duty and Tax 應用與一個自動同步追蹤編號到 Zonos 的平台,或者您直接通過 Dashboard 進行運送,則不需要這些 mutations。