顧客があなたのプラットフォームからZonosラベルを印刷できるようにする
以下の手順に従って、顧客があなたのプラットフォームからZonosラベルを取得できるようにします。
1
顧客が自分のZonos API資格情報を入力できるようにする
Zonos APIはcredentialToken
によってアクセス可能です。あなたのプラットフォームは、顧客Zonos DashboardからcredentialToken
を入力できるようにする必要があります。ここから、あなたは彼らの代理でZonosにリクエストを行うことができます。
2
出荷を作成する
label
を取得するためには、label
に関連付けられるshipment
を作成する必要があります。Zonosは、同じリクエスト内でshipments
とlabels
を作成するワークフローでこのプロセスを管理します。このミューテーションを実行する際、serviceLevel
を渡す必要はありません。なぜなら、order
に関連付けられたlandedCost
から使用されるserviceLevel
を使用するからです。orderId
にはZonosの注文IDまたはあなたのシステムにすでに存在する可能性のあるaccountOrderNumber
を使用できます。出荷とラベルが正常に作成されると、私たちはBASE64_ENCODED_IMAGE
としてのlabelImage
またはラベルを取得できるurl
としてラベルを返します。
ミューテーション
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
}
}
}
応答
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
出荷を無効にする
顧客が shipment
を無効にしたい場合、以下のミューテーションを使用することで、shipment
に関連付けられたすべての labels
を無効にすることができます。
リクエスト
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
}
}
あなたのプラットフォームからZonos出荷を作成する
顧客があなたのプラットフォームからZonos出荷およびラベルを作成できるようにします。
あなたがZonos顧客が国際的に出荷することをサポートする出荷プラットフォームである場合、出荷作成のためにZonosに接続することは最優先事項であるべきです。これにより、あなたのプラットフォームの既存の機能を活用しながら、Zonosが出荷、ラベル、およびサポートする通関書類の作成を管理できるため、あなたの商人とその顧客にとって最もシームレスな体験を提供できます。
Zonosを使用して出荷を作成する利点には以下が含まれます:
このガイドでは、あなたのプラットフォームから出荷のためにZonosを呼び出す完全なエンドツーエンドの統合を実装する手順を説明します。