让客户能够从您的平台创建Zonos出货单和标签。
本指南面向希望为其客户将Zonos出货创建功能集成到其平台中的运输平台开发人员。如果您已经在使用Zonos API,只需为现有订单创建出货单,请查看我们的出货创建指南。
如果您是一个支持Zonos客户进行国际物流的运输平台,与Zonos集成以进行出货创建应该是首要考虑事项。这将让您能够通过利用您平台现有的功能为您的商家及其客户提供最无缝的体验,同时让Zonos管理出货单、标签和相关海关文档的创建。
使用Zonos创建出货单的优势包括:
本指南将指导您实现完整的端到端集成,使您能够从您的平台调用Zonos进行出货单。
按照以下步骤允许您的客户从您的平台检索Zonos标签。
Zonos API可通过credentialToken访问。您的平台需要让客户能够从Zonos Dashboard输入他们的credentialToken到您的平台。从这里,您将能够代表他们向Zonos发出请求。
credentialToken
为了检索label,您需要创建一个与label关联的shipment。Zonos通过一个在同一请求中创建shipments和labels的工作流来管理此过程。执行此变更时,您不需要传递serviceLevel,因为我们将使用从与order相关的landedCost使用的serviceLevel。对于orderId,您可以使用Zonos订单ID或您系统中可能已有的accountOrderNumber。
label
shipment
shipments
labels
serviceLevel
order
landedCost
orderId
accountOrderNumber
成功创建出货单和标签时,我们将返回标签作为labelImage,这是一个BASE64_ENCODED_IMAGE,或作为一个url,可以从中获取标签。
labelImage
BASE64_ENCODED_IMAGE
url
在为现有订单创建出货单且不需要修改项目或方的详细信息时,使用此工作流。它支持可选的跟踪号、履行中心、服务级别选择和声明价值保险。
Shopify为原点方的person传递空值。因此,orderId单独对Shopify商家不起作用 — 使用高级出货创建选项卡并提供完整的方详细信息,包括person。
person
mutation CreateShipment($input: ShipmentCreateWorkflowInput!) {
shipmentCreateWorkflow(input: $input) {
id
status
trackingDetails {
number
}
serviceLevel {
name
carrier {
shipmentCartons {
carton {
width
length
height
weight
items {
item {
amount
description
label {
trackingNumber
documentFiling
变量选项:
"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-50,000美元之间的价值,并在纸箱级别处理声明价值。对于多纸箱出货单,商家必须分割出货单以指定每个纸箱的保险范围。UPS还生成必须与标签一起打印的额外保险表单。
FedEx和DHL:在出货单级别处理声明价值,无额外限制。
在纸箱上使用specialServices来指示电池、干冰、危险品或签名要求的特殊处理要求。查看特殊服务指南了解完整的详细信息和示例。
specialServices
ShipStation UPS解锁:不支持多件出货单。当订单在多个框中发货时,参考字段被重复,导致订单号匹配在后端失败。需要多件出货单的商家应改为在Zonos Dashboard中创建标签。单个框出货单不受影响。
在客户想要作废shipment的事件中,您可以使用以下变更来作废与shipment相关的所有labels。
mutation {
shipmentStatusUpdate(
input: {
shipment: "shipment_f1fe4dbd-e471-49fa-94e7-84e369083223"
status: VOIDED
note: "Voiding shipment"
) {
CartonCreateWorkflowInput ItemCreateWorkflowInput PartyCreateWorkflowInput ShipmentCreateWorkflowInput
cartonsCreateWorkflow itemCreateWorkflow partyCreateWorkflow shipmentCreateWorkflow shipmentStatusUpdate
平台出货集成
从您的平台创建出货单
让客户能够从您的平台创建Zonos出货单和标签。
本指南面向希望为其客户将Zonos出货创建功能集成到其平台中的运输平台开发人员。如果您已经在使用Zonos API,只需为现有订单创建出货单,请查看我们的出货创建指南。
如果您是一个支持Zonos客户进行国际物流的运输平台,与Zonos集成以进行出货创建应该是首要考虑事项。这将让您能够通过利用您平台现有的功能为您的商家及其客户提供最无缝的体验,同时让Zonos管理出货单、标签和相关海关文档的创建。
使用Zonos创建出货单的优势包括:
本指南将指导您实现完整的端到端集成,使您能够从您的平台调用Zonos进行出货单。
启用标签打印
按照以下步骤允许您的客户从您的平台检索Zonos标签。
允许API凭证
Zonos API可通过
credentialToken访问。您的平台需要让客户能够从Zonos Dashboard输入他们的credentialToken到您的平台。从这里,您将能够代表他们向Zonos发出请求。创建出货单
为了检索
label,您需要创建一个与label关联的shipment。Zonos通过一个在同一请求中创建shipments和labels的工作流来管理此过程。执行此变更时,您不需要传递serviceLevel,因为我们将使用从与order相关的landedCost使用的serviceLevel。对于orderId,您可以使用Zonos订单ID或您系统中可能已有的accountOrderNumber。成功创建出货单和标签时,我们将返回标签作为
labelImage,这是一个BASE64_ENCODED_IMAGE,或作为一个url,可以从中获取标签。在为现有订单创建出货单且不需要修改项目或方的详细信息时,使用此工作流。它支持可选的跟踪号、履行中心、服务级别选择和声明价值保险。
Shopify为原点方的
person传递空值。因此,orderId单独对Shopify商家不起作用 — 使用高级出货创建选项卡并提供完整的方详细信息,包括person。mutation CreateShipment($input: ShipmentCreateWorkflowInput!) {shipmentCreateWorkflow(input: $input) {idstatustrackingDetails {number}serviceLevel {idnamecarrier {idname}}shipmentCartons {idcarton {idwidthlengthheightweightitems {item {idamountdescription}}}label {urltrackingNumberiddocumentFiling}}}}变量选项:
"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-50,000美元之间的价值,并在纸箱级别处理声明价值。对于多纸箱出货单,商家必须分割出货单以指定每个纸箱的保险范围。UPS还生成必须与标签一起打印的额外保险表单。
FedEx和DHL:在出货单级别处理声明价值,无额外限制。
特殊服务
在纸箱上使用
specialServices来指示电池、干冰、危险品或签名要求的特殊处理要求。查看特殊服务指南了解完整的详细信息和示例。ShipStation UPS解锁:不支持多件出货单。当订单在多个框中发货时,参考字段被重复,导致订单号匹配在后端失败。需要多件出货单的商家应改为在Zonos Dashboard中创建标签。单个框出货单不受影响。
作废出货单
在客户想要作废
shipment的事件中,您可以使用以下变更来作废与shipment相关的所有labels。mutation {shipmentStatusUpdate(input: {shipment: "shipment_f1fe4dbd-e471-49fa-94e7-84e369083223"status: VOIDEDnote: "Voiding shipment"}) {idstatus}}CartonCreateWorkflowInput ItemCreateWorkflowInput PartyCreateWorkflowInput ShipmentCreateWorkflowInput
cartonsCreateWorkflow itemCreateWorkflow partyCreateWorkflow shipmentCreateWorkflow shipmentStatusUpdate
这个页面有帮助吗?