DOCS

Integrate label api

/

あなたのプラットフォームからZonos出荷を作成する

顧客があなたのプラットフォームからZonos出荷およびラベルを作成できるようにします。

国際的に出荷するZonos顧客をサポートする出荷プラットフォームである場合、出荷作成のためにZonosに接続することは最優先事項であるべきです。これにより、あなたのプラットフォームの既存の機能を活用しながら、Zonosが出荷、ラベル、および関連する通関書類の作成を管理できるため、商人とその顧客にとって最もシームレスな体験を提供できます。

Zonosを使用して出荷を作成する利点には以下が含まれます:

  • 関税および税金の第三者請求 - 出荷料金にはあなたまたはあなたの商人のキャリアアカウント番号が使用され、関税および税金の請求書はZonosに送られます。
  • 柔軟性 - プラットフォームで準拠したラベルを生成できるようにするための開発作業を行う代わりに、私たちのAPIと統合し、常に変化する国境を越えたコンプライアンスを私たちに任せてください。
  • 正確な通関書類 - Zonosを使用してラベルを生成する際、パッケージが迅速に通関を通過できるように、正しい詳細がキャリアに渡されることを保証します。

このガイドでは、あなたのプラットフォームから出荷のためにZonosを呼び出す完全なエンドツーエンドの統合を実装する手順を説明します。

顧客があなたのプラットフォームからZonosラベルを印刷できるようにする 

以下の手順に従って、顧客があなたのプラットフォームからZonosラベルを取得できるようにします。

1

顧客が自分のZonos API資格情報を入力できるようにする

Zonos APIcredentialTokenによってアクセス可能です。あなたのプラットフォームは、顧客Zonos DashboardからcredentialTokenを入力できるようにする必要があります。ここから、あなたは彼らの代理でZonosにリクエストを行うことができます。

2

出荷を作成する

labelを取得するためには、labelに関連付けられるshipmentを作成する必要があります。Zonosは、同じリクエスト内でshipmentslabelsを作成するワークフローでこのプロセスを管理します。このミューテーションを実行する際、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
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
    }
  }
}

応答

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

出荷を無効にする

顧客が 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
  }
}

このページは役に立ちましたか?