DOCS

プラットフォーム出荷統合

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

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

このガイドは、顧客のために Zonos の出荷作成機能をプラットフォームに統合したい配送プラットフォームの開発者向けに設計されています。すでに Zonos API を使用していて、既存の注文の出荷を作成するだけが必要な場合は出荷作成ガイドをご覧ください。

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

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

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

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

ラベル印刷を有効にする 

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

1

API 認証情報を許可する

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

2

出荷を作成する

label を取得するためには、label に関連付けられる shipment を作成する必要があります。Zonos は、同じリクエスト内で shipmentslabels を作成するワークフローでこのプロセスを管理します。このミューテーションを実行する際、order に関連付けられた landedCost から使用される serviceLevel を使用するため、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
mutation CreateShipment($input: ShipmentCreateWorkflowInput!) {
  shipmentCreateWorkflow(input: $input) {
    id
    status
    trackingDetails {
      number
    }
    serviceLevel {
      id
      name
      carrier {
        id
        name
      }
    }
    shipmentCartons {
      id
      carton {
        id
        width
        length
        height
        weight
        items {
          item {
            id
            amount
            description
          }
        }
      }
      label {
        url
        trackingNumber
        id
        documentFiling
      }
    }
  }
}

基本変数

1
2
3
4
5
6
{
  "input": {
    "generateLabel": true,
    "orderId": "order_12345678-1234-1234-1234-123456789abc"
  }
}

フルフィルメントセンターを使用

1
2
3
4
5
6
7
{
  "input": {
    "generateLabel": true,
    "orderId": "order_12345678-1234-1234-1234-123456789def",
    "fulfillmentCenter": "fulfillment_center_12345"
  }
}

カスタムトラッキングを使用して

1
2
3
4
5
6
7
{
  "input": {
    "generateLabel": false,
    "orderId": "order_12345678-1234-1234-1234-123456789ghi",
    "trackingNumbers": ["tracking_example_1", "tracking_example_2"]
  }
}

サービスレベル付き

1
2
3
4
5
6
7
{
  "input": {
    "generateLabel": true,
    "orderId": "order_12345678-1234-1234-1234-123456789jkl",
    "serviceLevel": "dhl.express_example"
  }
}

宣言された価値保険付き

1
2
3
4
5
6
7
{
  "input": {
    "generateLabel": true,
    "orderId": "order_12345678-1234-1234-1234-123456789mno",
    "isDeclaredValue": true
  }
}

宣言された価値

"isDeclaredValue": true を設定して、出荷のすべてのアイテムに対して宣言された価値の補償を有効にします。 Zonos は、注文に提出されたすべてのアイテムの完全な価値を自動的に請求します。商人はこの金額を変更することはできません。これは、輸送中の紛失、損傷、または盗難が発生した場合に、運送業者が受け入れる最大の責任を設定します。この機能は、UPS、FedEx、およびDHLの出荷のみでサポートされています。 Zonos は、宣言された価値を有効にすると、これらの運送業者へのAPI呼び出しに適切なパラメータを含めるなど、運送業者固有の実装を自動的に処理するため、異なる運送業者の要件を管理する必要はありません。

UPSの制限: UPSは、100-50,000 USDの間の価値のみをカバーし、宣言された価値をカートンレベルで処理します。複数カートンの出荷の場合、商人はカートンごとに補償を指定するために出荷を分割する必要があります。UPSは、ラベルと一緒に印刷する必要がある追加の保険フォームも生成します。

FedExおよびDHL: 追加の制限なしで出荷レベルで宣言された価値を処理します。

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

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


このページでは: