ユーザーガイド - UPS.com

ユーザーガイド
UPS® 開発者向けキット
© 2014 United Parcel Service of America, Inc. UPS、UPSのブランドマーク、color brownは、United Parcel Service of America, Inc.の商標です。All rights reserved.jp_ja
UPS開発者向けキットユーザーガイド
目次
UPS開発者向けキットユーザーガイド
はじめる前に
. . . . . . . . . . . . .
3
. . . . . . . . . . . . . . . . . . . . . . . . . .
5
技術的問題点とアクセス要件. .
実装
はじめに.
製品概要
. . . . . . . . . . . .
18
. . . . . . . . . . . . . . .
26
出荷と評価ビジネスプロセス. .
可視性ビジネスプロセス .
国際貿易ビジネスプロセス.
. . . . . . . . . . . . . .
30
UPS開発者向けリソースセンター
. . . . . . .
35
. . . . . . . . . . . . . . . . . . . . . . . . .
36
リソースと技術サポートへのアクセス .
リソース.
技術サポート .
. . . . . . . . . . . . . . . . . . . . . .
37
i
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
UPS開発者向けキットユーザーガイドへようこそ。本
ガイドでは、開発者向けキットとサーバーにアクセス
して、UPSとテストし取引する方法についての情報を
説明します。操作時間や応答時間を含む、APIの技術サ
ポートに関する詳細情報も説明します。
ups.comのUPS開発者向けキットページ
このページにアクセスするには、以下にアクセスします。
ups.com/developerkit
UPS開発者向けキットは、UPSの機能性をビジネスシ
ステムおよびeコマースWebサイトに直接統合する上で
の柔軟性を提供します。UPSは、API経由で11の機能を
提供するため、ビジネスプロセスの効率性を改善し、
顧客のWebエクスペリエンスを向上させることができ
ます。
1
© 2014 United Parcel Service of America, Inc. All rights reserved.
はじめる前に
UPS開発者向けキット
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
技術的な問題
APIをダウンロードする前に、以下に精通している必
要があります。
• URLまたはソケット接続のプログラミング
• セ
キュア接続のためのSSL標準に対応したセキュア
ソケットの実装の作成
• XMLドキュメントのエンコードとデコード
• エ
ラー処理用の既存のソフトウェアの戦略の設計
と実装
利用可能なバージョン（XMLまたはWeb Services）、
モード（Package、LTL Freight、Air Freight）、国をチ
ェックします。
アクセス要件
特定のAPIがテストと本番用アクセスとともに最初のア
クセスキーリクエストを提供するかどうか、またはさ
らなる本番用アクセスリクエストが必要とされるかど
うか確認します。ビジネスモデルが各APIで使用される
ことが承認されている場合も、確認が必要です。
注:
• アプリケーションのビジネスロジックとデータを
APIに採用するカスタムコードを、API機能をeコマー
スおよびビジネスシステムアプリケーションに統合
するために開発する必要があります。インターネッ
トソケット経由のHTTP通信とセキュア接続に対応し
た、Java、Visual Basic、またはC++ などのプログラ
ミング言語を使用できます。
• T NT APIを効果的に統合できるようにするため、開
発者向けキットには、以下のガイドと参考資料が同
梱されています。Visual Basic、Java、.Net、C++,
Perl、PHPを含む開発者ガイド（技術FAQを含む）、
UPSロゴとバナー、コードサンプル
3
© 2014 United Parcel Service of America, Inc. All rights reserved.
実装
UPS開発者向けキット
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
はじめに
u
i ps.com®でUPS開発者向けキットセクションにアク
セスするには、［サポート］メニューの［技術サ
ポート］を選択します。
［技術サポート］ページにアクセスし、[ツール]
と[リソース]の［UPS開発者向けキット］を選択
します。
5
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
はじめに（続）
手順1: M
y UPSに登録
すでに登録されている場合、手順4にスキッ
プします。
手順2: ロ
グイン
usernameを入力します。［次へ］をクリック
します。それから、パスワードを入力するよ
うにプロンプトが表示されます。資料ファイ
ルをダウンロードするためにログインする必
要があります。
6
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
はじめに（続）
手順3: APIの選択
Developer APIで、必要なそれぞれのAPIに対す
る要件を探し、ダウンロード可能なファイル
ならびに特定の国のアベイラビリティにアク
セスすることができます。本ガイドの21ペー
ジ目にある製品概要セクションも参考にでき
ます。
7
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
はじめに（続）
手順4: A
PI資料のダウンロード
1. 選択したAPIのzipファイルのダウンロード
2. プロンプトが表示されたら、［保存］をク
リックします
3. ローカルコンピュータの抽出ファイル
ダウンロードされたファイルには、ソフトウェア開発
者向けキットが含まれます。統合するAPIに対する開発
者ガイド全体を注意深く確認します。ソフトウェア開
発者向けキットには、サンプルコードとWSDLも含まれ
ます。
8
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
はじめに（続）
UPSはすべてのAPIのアクセスキーにアクセス可能なテ
スト環境を提供します。これは、XMLまたはWebサー
ビスリクエストをきちんとフォーマット設定するため
にライブでリクエストと、応答メッセージの発信をシ
ミュレーションできます。
ほとんどのAPIでは、テストと本番用環境の両方にす
ぐにアクセスできます。しかし、以下のAPIで本番
用のアクセスを有効にするためには、2回目のリク
エストが必要になります。LocatorおよびLTL Freight
API（Pickup、Rating、Shipping）です。
手順5: ア
クセスキーのリクエスト
ソフトウェア開発者向けキットを確認した
ら、UPSテスト環境へのアクセス権をリクエス
トする必要があります。以下を行うように求
められます。
1. アカウントの情報の提供
2. アカウント情報の認証
3. 認証したら、リクエストが受け付けられた
ことの確認通知を受信します。
9
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
はじめに（続）
手順5: ア
クセスキーのリクエスト（続）アカウント
情報の提出
10
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
はじめに（続）
手順5: ア
クセスキーのリクエスト（続）
1. アカウント認証の提供
2. 認証が完了したら、［アクセスキーのリ
クエスト］ページに戻ります。
3. 下にある［アクセスキーのリクエスト］
をクリックします。
注記: Account Invoice Authentication（AIA）
は、ShippingおよびRating API経由で交渉料金を表示
するために必要です。My UPS（ups.com）でAIA認証
に対する最新の請求書のコピー（45日間以内）があ
ることを確認します。
11
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
はじめに（続）
手順5: ア
クセスキーのリクエスト（続）
リクエストが受け付けられた確認通知を
見て、確認メールを受信します。
12
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
アクセスと管理
アクセスキーの表示/更新
アクセスキーを管理および更新するには、［UPS開発
者向けキット］ページに移動し、［アクセスと管理］
セクションの［アクセスキーの管理］を選択します。
13
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
アクセスと管理（続）
アクセスキーの表示/更新（続）
• ［
アクセスキーの表示/更新］セクションにアクセ
スキーを入力します。
• 次
のセクションでは、入力したキーに対して、ステ
ータスとともにAPIのリスト（テストまたは本番用）
を表示します。
注記: そのページから、本番用アクセスまたは新しい
アクセスキーもリクエストします。
14
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
アクセスと管理（続）
アカウント/連絡先情報の編集
主要連絡先および代替連絡先情報のみならず、ア
カウント情報を更新するには、［UPS開発者向け
キット］ページに移動し、［アクセスと管理］セ
クションの［管理］を選択します。
15
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
アクセスと管理（続）
アカウント/連絡先情報の編集（続）
連絡先情報が表示されます。［編集］を選択して変更
します。
注記: UPS証明書に対する変更やその他の大きな変更
に関する特定の電子メール通知では、連絡先情報が最
新のものであることが非常に重要です。また、インテ
グレーターを使用した場合、重要な情報を受け取れる
ように、連絡先情報が会社のIT連絡先に変更されてい
ることが重要です。
変更を行うための新しい画面が表示されます。終了し
たら、［変更の保存］をクリックします。
16
© 2014 United Parcel Service of America, Inc. All rights reserved.
製品概要
UPS開発者向けキット
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
出荷と評価ビジネスプロセス
アドレス認証API
国およびプエルトリコのす
米
べての交通手段
利用可能なバージョン: XMLのみ
利用可能なモード: すべてのモード
アクセス要件: テストおよび本番用アクセス
に1つのリクエスト
利用可能な国: WebページまたはWebでないオーダーシステムのいず
れに統合するのかにかかわらず、Address Validation
API を使用すると、バイヤーが提供した市町村-都道
府県-郵便番号の組み合わせをUPSの中央コンピュータ
ー（サーバー）に維持されているものと比較できるよ
うになります。組み合わせが有効ではない場合、UPS
は市区町村、都道府県、郵便番号の候補のリストをア
プリケーションに返します。UPSは最大10個の住所の
候補を提供します。
API制限
承認されているビジネスモデル
• 1
回のリクエストあたり1つの市区町村-都道府県郵便番号の組合せのみ確認します
• 出荷のためにUPSに提供される積荷の住所確認
• 米国およびプエルトリコの住所のみ確認が可能
• API応答では緯度経度座標は提供されません
• 市
区町村-都道府県-郵便番号の組合せの確認の
み — 番地を含む住所ではない
承認されていないビジネスモデル/使用法
• UPS住所データベースは、USPSによって提供され
た情報で毎月更新されます
• 住所データベースの「スクラビング」
• CASS認定の検証用エンジンではありません
• UPS出荷以外の用途のための住所確認
• C
ASS AVソフトウェアの要件に代わるものではあ
りません
18
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
出荷と評価ビジネスプロセス（続）
Address Validation Street Level API
WebページまたはWebでないオーダーシステムのいず
れに統合するのかにかかわらず、Address Validation
Street Level (AVSL) API を使用すると、バイヤーが提
供した番地-市町村-都道府県-郵便番号の組み合わせ
をUPSの中央コンピューター（サーバー）に維持され
ているものと比較できるようになります。組み合わせ
が有効ではない場合、UPSは番地、市区町村、都道府
県、郵便番号の候補のリストをアプリケーションに返
します。UPSは最大10個の住所の候補を返します。
さらに、米国とカナダ（分類はUSPS情報に基づかない
UPS内部の活動分類）について、AVSL APIは事業用/住
宅の住所を分類します。
承認されているビジネスモデル
• 配送のためにUPSによって提供される住所確認
国およびプエルトリコ
米
ではすべての交通手段
利用可能なバージョン: XMLおよびWebサービス
利用可能なモード: すべてのモード
アクセス要件: テストおよび本番用アクセス
に1つのリクエスト
利用可能な国: API制限
• 米国およびプエルトリコの住所のみ確認が可能
• 米
国およびカナダの住所のみを分類（商業/住居）
します
• リ
クエストあたり1つの番地、市区町村、都道府県、
郵便番号の組合せのみ確認します
• ア
パートメントまたは部屋がAPIリクエスト内で提
供される場合、またはアパートメントまたは部屋が
UPSデータベースに存在する場合のみ、アパートメ
ントまたは部屋を検証します。
• API応答では緯度経度座標は提供されません
• 住所データベースの「スクラビング」
• UPS住所データベースは、USPSによって提供された
情報で毎月更新されます
• UPS出荷以外の用途のための住所の確認
• CASS証明アプリケーションではありません
承認されていないビジネスモデル/使用法
• CASS AVソフトウェアの要件に代わるものではあり
ません
19
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
出荷と評価ビジネスプロセス（続）
Locator API
Locator APIでは、住所や電話番号を使用して、ユー
ザーが地域のUPSサービスを見つけることができま
す。Locator APIではUPSのフルサービスおよびセルフ
サービスの場所、営業時間、ピックアップ時間を提
供します。Locator APIは、所在地、追加のサービス、
プログラムタイプ、タイプコード、所在地が店舗の場
合を含む、別の構成情報を示すようにカスタマイズで
きます。さらに、Locatorはインタラクティブなマップ
を提供し、最大10のUPS所在地と経路案内を表示しま
す（利用可能な場合）。
次のような所在地の検索:
• The UPS Store®
• Mail Boxes Etc.®
• UPSお客様サービスセンター
スモールパッケージにのみ27カ国で利用可能です
利用可能なバージョン: XML
利用可能なモード: パッケージ
アクセス要件:
テストおよび本番用アクセス
につき2つの別のリクエスト
承認されているビジネスモデル
• マ
ーチャントのWebサイトとWebでないバックエ
ンドシステムで使用
承認されていないビジネスモデル/使用法
• サ
ードパーティのロジスティクスプロバイダー
で使用
API制限
• 緯度経度座標は提供されません
• マップは提供されません
• UPSドロップボックス
• UPS Express®
• UPS提携店
• UPSリテールパートナー
• UPS指定の取扱い業者
20
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
出荷と評価ビジネスプロセス（続）
Pickup API
Pickup APIでは、ユーザーが自宅やオフィスからのUPSの
ピックアップをスケジュールできます。前に処理された
パッケージ、運賃発送、または新しい出荷のピックアッ
プもスケジュールできます。さらに、UPSの環境にやさ
しい収集オプションは、スモールパッケージPickup API
で利用できます。
スモールパッケージとLTL
利用可能なバージョン:
利用可能なモード: アクセス要件:
Freightについては36か国で利用可能
Webサービス
Package、LTL Freight
テストおよび本番用アクセスに対して
Pickup API Small Packageのリクエス
ト1つ、テストおよび本番用アクセス
に対してPickup API Ground Freightの
別のリクエスト2つ
承認されているビジネスモデル
• マ
ーチャントのWebサイトとWebでないバックエンド
システムで使用
承認されていないビジネスモデル/使用法
• ピ
ックアップリクエストのサードパーティのホスティ
ング
• サードパーティのロジスティクスプロバイダーで使用
API制限
• なし
21
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
出荷と評価ビジネスプロセス（続）
Rating API
Rating APIは、UPSによるサービスが利用可能なすべて
の目的地に対して、UPSスモールパッケージおよびUPS
Freight® LTLサービスレベルの料金（毎日のピックアッ
プ、オンデマンド、または店舗）を提供します。Rating
APIは、利用可能なすべての料金（「ショップ」オプシ
ョン）や、特定のサービスレベルの料金（「料金]オプ
ション）を示すように設定できます。公表されている
料金がデフォルトで示されます。アカウント固有の交
渉料金は、My UPSタブにあるups.comの［アカウント
サマリ］または［アカウントメンテナンス］ページに
ある［アカウント請求書による承認］によって有効にす
ることができます。詳細については、本ガイドの11ペ
ージを参照してください。Rating APIは、Ground（Timein-Transit APIがこの情報に使用される必要があります）
以外のすべてのサービスの配送日と配送時間をお知ら
せします。
承認されているビジネスモデル
• マ
ーチャントのWebサイトとWebでないバックエン
ドシステムで使用
承認されていないビジネスモデル/使用法
• 競合料金と並べて比較したUPS料金の表示
スモールパッケージでは66か国で、LTL Freightでは4か国で、Air
Freightでは36か国（Gemini API）で利用できます
利用可能なバージョン: XMLおよびWebサービス（メモを参
照）
利用可能なモード: Package、LTL Freight(1)、Air Freight (2)
アクセス要件: LTL Freightに対するテストおよび本
番用アクセスの異なる2つのリクエス
ト、Gemini APIリクエストフォーム経
由のAir Freightに対する手動リクエス
ト（ups.comでUPS開発者向けキット
のリンクを参照してください）
注:
(1) LTL Freight 専用のWebサービス
(2) Gemini API XML経由専用のAir Freight
API制限
• 単一パッケージの発送料金のみ
• 限
定された付帯項目のみをサポート:
– 保険価額
– 土曜集荷
– 土曜配達
– 追加取扱
• A
ir Freightの料金は、Gemini APIsを使用する必要が
あります。Gemini APIsリクエストフォームおよび
開発者ガイドへのリンクについては、UPS開発者向
けキットホームページと、AnnouncementsおよびAPI
Updateセクションを参照してください。このAPIへア
クセスするには、リクエストフォームをきちんと読
んでください。
22
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
出荷と評価ビジネスプロセス（続）
Shipping API
Shipping APIは、企業システムとWebサイトでのUPSの
出荷機能の統合をサポートします。統合では、出荷へ
の便利で管理されたアクセスにより内部プロセスをサ
ポートしながら、ユーザーがキーを入力する必要な
く、送り主のアプリケーションからのデータを使用
できます。Shipping API は、海外からの返品を含む、
スモールパッケージ全体のUPS Returns®ポートフォリ
オもサポートします。UPSの住宅/事業用住所の分類
と、市区町村、都道府県、郵便番号の確認も行われま
す。UPS Shipping APIの統合は、大幅なプログラミン
グ時間と専門知識が必要です。
Shipping APIの能力
スモールパッケージでは66か国で、LTL Freightでは4か国で、
Air Freightでは36か国（Gemini API）で利用できます
利用可能なバージョン: XMLおよびWebサービス（メモを
参照）
利用可能なモード: Package、LTL Freight(1)、Air Freight (2)
アクセス要件: LTL Freightに対するテストおよび本
番用アクセスの異なる2つのリクエス
ト、Gemini APIリクエストフォーム経
由のAir Freightに対する手動リクエス
ト（ups.comでUPS開発者向けキット
のリンクを参照してください）
注:
(1) LTL FreightはWebサービス専用です
(2) Gemini API XML経由専用のAir Freight
プロセスは次の2段階で構成されます。［Ship
Confirm（出荷確認）］段階は、［Ship Accept（出荷
受付）］段階に続きます。XMLリクエスト/応答のペ
アは、それぞれの段階でクライアントとサーバーの
間で交換されます。出荷のキャンセルや無効化は手
順とメッセージの入力を必要とすることに注意して
ください。
承認されているビジネスモデル
• マ
ーチャントのWebサイトとWebでないバックエン
ドシステムで使用
• ア
クセスのためのコントロールをWebサイトに組み
込むとき
23
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
出荷と評価ビジネスプロセス（続）
Shipping API（続）
承認されていないビジネスモデル/使用法
• 競合料金と並べて比較したUPS料金の表示
• 外
部またはWebベースの実装において、競合者と
並べての比較は行わないこと
• WebサイトでShipping APIのホスティングを行わな
いこと
API制限
• 処
理時間の平均はトランザクションごとに8秒です。
大容量の本番用の出荷環境には適しません
• 公
表されている料金がデフォルトで示されます。
アカウント固有の交渉料金は、My UPSタブにある
ups.comの［アカウントサマリ］または［アカウン
トメンテナンス］ページにある［アカウント請求書
による承認］によって有効にすることができます。
詳細については、本ガイドの11ページを参照して
ください。
• サ
ポートされていません。危険物質、World Ease®、
バッチ処理、UPS Hundredweight Service®集約
24
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
出荷と評価ビジネスプロセス（続）
Time-in-Transit API
Time-in-Transit APIでは、ユーザーがサービスごとの配
送スピードを比較します。それにより、出荷に最適な
サービスを選択できます。このAPIは、世界中のUPSが
配送する場所で利用可能なすべてのUPS出荷サービス
へアクセスできるようにします。情報には、配送日と
時間、配送日数のスケジュールを含みます。UPSの祝
日と週末を考慮に入れた、グラウンドパッケージの配
送の日付と時間を提供します。
スモールパッケージにのみ66カ国で利用可能です
利用可能なバージョン: XMLおよびWebサービス
利用可能なモード: パッケージ
アクセス要件: UPS承認ビジネスモデルについて
はテストおよび本番用アクセスの
ために1つのリクエスト
承認されているビジネスモデル
• マ
ーチャントのWebサイトとWebでないバックエン
ドシステムで使用
承認されていないビジネスモデル/使用法
• ト
ランザクションの関係者でない第三者の情報ロ
ジスティクスプロバイダーによる使用
• UPSの機密情報からTime-in-Transit表を作成
API制限
• なし
25
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
可視性ビジネスプロセス
Quantum View™ API
Quantum View™Dataは、スプレッドシートや簡単なデ
ータベースからERPシステムまで、社内の内部アプリ
ケーションにシームレスに統合可能な総合追跡情報を
提供します。
出荷状況の更新は、多くの一般的なデータファイル形
式（CSV、XML、TXTまたはEDI ANSIまたはEDI EDIFACT）
で、必要に応じて毎時間の頻度で内部システムに自動
的にダウンロードできます。
• アウトバウンド
• インバウンド
• 第
三者 - 運賃着払、第三者、UPS 荷受人請求を通
してUPSのアカウントに請求される出荷に関する最
新の情報。
XML Quantum Viewサービスを理解する
Quantum Viewは情報を「イベント」として示します。
このAPIで、お客様のアプリケーションで自動的に
Quantum Viewイベントを取得したり、これらのイベン
トを他の情報システムの処理に統合したりすることが
可能になります。
スモールパッケージのみ31カ国で利用可能です
利用可能なバージョン: XML
利用可能なモード: パッケージ
アクセス要件: テストおよび本番用アクセス
に1つのリクエスト
購読
この機能でどのタイプのQuantum Viewイベントを取得
するか指定できます。アウトバウンド出荷、インバウ
ンド出荷、代理請求を使用した出荷に対して、購読を
セットアップできます。これらの購読には、マニフェ
スト、出荷元、配送、例外アクティビティを含むこと
ができます。Quantum View購読は、ups.comを通して
作成されます。受け取る情報や購読のタイプを管理す
るには、ups.comですべて行うことができます。購読
を有効にするには、営業担当者に連絡する必要があり
ます。
ブックマーク
アクティビティ量が多いユーザーに関して、そして
ネットワークリソースの負荷を軽減するために、
Quantum View APIは、単一のリクエストに返す情報
量を制限できます。この制限は、複数を組み合わせた
ファイルついてはおよそ150KB、単一のファイルでは
500KBです。制限を超えたファイルについては、UPSは
情報の一部を返し、特別なブックマーク要素を応答に
加えます。追加情報を取得するには、元のリクエスト
をブックマーク要素を追加した状態で再発行します。
26
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
可視性ビジネスプロセス（続）
Quantum View API（続）
情報形式
アプリケーションがQuantum Viewイベントをリクエ
ストしたとき、APIは前に表示していないイベントの
みを返します。ファイル名と日付/時間のリクエスト
は、このルールにのみ期待されます。
承認されているビジネスモデル
• マーチャントWebサイトとWebでないバックエンド
システムで使用します
承認されていないビジネスモデル/使用法
• サ
ードパーティのロジスティクスプロバイダーで
使用
API制限
• 更
新はバッチで処理され、1時間ごとの更新に制限
されます
• 変
更されたもののみが１時間ごとのファイル更新に
含まれるように、ファイルを既存のデータにアペン
ドする必要があります。
• マ
ニフェスト、期待、配送スキャンのみがファイ
ル内で提供されます。中間のスキャンではありま
せん（移動中のスキャン）
27
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
可視性ビジネスプロセス（続）
追跡API
Tracking APIは透明性を提供し、顧客がリファレンスま
たは注文番号を使用したeコマースサイトから、出荷を
追跡できるようにします。顧客のパッケージが最終目
的地に向かう間、スキャンが発生するたびに、時刻や
場所など出荷状況の具体的な情報が提供されます。さ
らに、お客様のサイトの外観に合わせて、追跡情報を
シームレスに混ぜることも可能です。
すべての出荷モードは66か国で利用可能
利用可能なバージョン: XMLおよびWebサービス
利用可能なモード: すべてのモード
アクセス要件: テストおよび本番用アクセスに1つの
リクエスト
API制限
• 出荷サイズに関係なく応答あたり64KBの制限
承認されているビジネスモデル
• 50パッケージの出荷では、パッケージでどれほどの
追跡情報が利用可能なのかによって、最初の15パッ
ケージのみを返すことができます。
• マ
ーチャントのWebサイトとWebでないバックエンド
システムで使用
• バ
ッチではない処理と追跡番号のバッチアップロー
ドをしないこと
承認されていないビジネスモデル/使用法
• APIは単一の追跡または各追跡リクエストのリファレ
ンス番号のみを追跡します。
• ト
ランザクションの関係者でない第三者の情報ロジ
スティクスプロバイダーによる使用
• 指
定されたイベントまでアウトバウンドパッケージ
ごとに追跡する「robots」で使用します
• パッケージスキャンと重量情報は6か月利用できます
• リファレンス番号追跡は4か月利用可能です
• 配送スキャン情報は18か月利用可能です
28
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
可視性ビジネスプロセス（続）
UPS Signature Tracking® API
UPS Signature Tracking APIはTracking APIと同じ情報
を提供します。
スモールパッケージのみ45カ国で利用可能です
利用可能なバージョン: XMLおよびWebサービス
利用可能なモード: パッケージのみ
アクセス要件: UPS承認ビジネスモデルについて
はテストおよび本番用アクセスの
ために1つのリクエスト
• 受取人の名前と住所
• C.O.D.集金額
承認されているビジネスモデル
• Proof of Delivery (POD)署名画像
• マ
ーチャントのWebサイトとWebでないバックエン
ドシステムで使用
マーチャントはPOD文字画像をシステムに統合し、バ
イヤーに積極的にPODレターを自動的に、または不払
いまたはPODのリクエストに対応して、電子メール、
郵送、またはファックスします。POD文字に受取人の
署名が含まれる場合（集荷時）、このソリューション
は標準的なTracking APIにより提供される「明確な」
（UPSドライバーサービスプロバイダーによって入力
される）署名情報を満たさないバイヤーの要求を満た
すことができます。
注記: リクエストの処理には、アカウント番号がMy
UPS IDアカウントサマリに含まれており、追跡される
追跡番号がそのアカウント番号で生成されていること
が必要です。アカウントがXMLリクエストで使用され
るMy UPS IDに対するMy UPS IDアカウントサマリに追
加されない限り、ほかのアカウントで生成された追跡
番号は使用できません。
承認されていないビジネスモデル/使用法
• ト
ランザクションの関係者でない第三者の情報ロ
ジスティクスプロバイダーによる使用
• 指
定されたイベントまでアウトバウンドパッケー
ジごとに追跡する「robots」で使用します
API制限
• Tracking APIと同じ
• 署名の保管に関する追加の制限は18か月です
29
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
国際貿易ビジネスプロセス
Paperless Document API
Paperless Document APIは、発送に関連する資料画像を
アップロードする機能があります。これは、紙の出荷
書類をパッケージに添付する必要性や、処理の遅延に
関連する問題をなくします。このAPIは、Shipping API
や他の積荷目録システムに関連して使用されます。こ
の機能は本質的に、書類が紛失したり損傷したりして
しまうわずらわしさをなくし、処理のために必要な出
荷と書類画像のシームレスで自動的なリンクを可能に
します。
注記: 有効な6桁の番号を持ち、UPSバックエンドシ
ステム内のアカウントのUPS Account Managerによ
って有効にして、ups.comのUpload My Formsまた
は Paperless Document APIを使用する必要がありま
す。Upload Formsの送り主の番号がバックエンドシス
テム内で有効ではない場合、Paperless Document API
では難しいエラーが発生します。
スモールパッケージは66カ国で利用可能です
利用可能なバージョン: Webサービス
利用可能なモード: スモールパッケージ
アクセス要件: UPS承認ビジネスについては
テストおよび本番用アクセス
に1つのリクエスト
Paperless Document API処理の理解
• P
aperless Document APIWebサービスは3つの操作で
構成されています。
1. F orms Historyに資料をアップロードします（34ペ
ージのAPI制限を参照）。
2. ア
ップロードされた資料を削除します（リクエス
トを削除するごとに1つの資料ID）。
3. Image Repositoryにアップロードされた資料をプ
ッシュします。
注記: 作成された資料画像のアップロード、削除、プ
ッシュリクエストを開始するために、アプリケーショ
ンによって必要な情報を収集する入力画像を構築する
必要があります。
30
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
国際貿易ビジネスプロセス（続）
Paperless Document API（続）
Shipping APIまたは他の積荷目録システムとともに
Paperless Document APIを使用する時、2つのオプシ
ョンがあります。
オプション1:
手順1: P
aperless Document APIに進み、アップロード
リクエストを完了します。Forms Historyに資料
をアップロードし、ドキュメントIDを受け取り
ます。
手順2: S hipping APIに進み、リクエストを提出して、
手順1からドキュメントIDとともに国内または
国際出荷を作成します。Shipping APIは、資料
をフォームリポジトリに内部でプッシュし、応
答でフォームグループIDを返します。
オプション2:
手順1: P
aperless Document APIに進み、アップロード
リクエストを完了します。Forms Historyに資料
をアップロードし、ドキュメントIDを受け取り
ます。
手順2: S hipping APIに進み、リクエストを提出して、
国内または国際出荷を作成します。出荷ID番号
および追跡番号を受け取ります。
手順3: P
aperless Document APIに進み、手順1のド
キュメントIDと手順2の出荷ID番号と追跡番
号を提供します。Push To Image Repository
Requestに記入します。これは、資料をフォー
ムリポジトリにプッシュし、フォームグルー
プIDをお客様に返します。
承認されているビジネスモデル
• 国
際ビジネスプロセスまたは他のバックエンドシ
ステム内の資料を必要とする出荷で使用します。
これは、Webのホスティング用ではありません。
承認されていないビジネスモデル/使用法
• サ
ードパーティのロジスティクスプロバイダーで
使用
API制限
• APIは複数のファイルと各ファイルの複数の資料を
処理する能力があります。
– す
べてのファイルの最大許可サイズが5MBなのに
対して、各ファイルの最大許可サイズは1MBです。
– 各
ファイルまたは発送ごとの合計で、13ファイル
以上にならないリクエストにつき、最大13ファイ
ル許可されます。
• 各資料画像に対して2つの手順があります。
手順1: 画像をアップロードします。
手順2: S hipping API またはPaperless Document API
のどちらかで画像を提出します。
31
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
国際貿易ビジネスプロセス（続）
UPS TradeAbility® APIs
UPS TradeAbilityは、情報ベースのサービスを提供し、
国際的な商品の移動を効率的に管理できるようにしま
す。TradeAbility APIsは、規制コンプライアンスを改善
し、運営費用を削減して、グローバルなサプライチェ
ーンと国際貿易のプロセスを合理化します。
• Landed Cost API
国際出荷のコストをなくします。関税、税が含ま
れます。Landed Costの見積りにはデフォルトで特
定関税料金が含まれる場合があります。適用され
るこれらの料金については、出荷時に、送り主が
適切な資料を同封して提出する必要があります。
トランザクションは1カ所から1カ所への発送につ
き、最大99製品を含むことが可能です。ランデッ
ドコストのもっとも正確な予想を提供するため、
サービスはインタラクティブなクエリで予想を絞
り込み、QueryRequest 要素を使用して返答する
ことができます。ユーザーはリクエストを再発行
し、EstimateRequest要素を使用して回答を含めま
す。UPSが必要な情報をすべて受け取ったら、ラン
デッドコストの予想が提供されます。
スモールパッケージは32か国で利用可能です
利用可能なバージョン: Webサービス
利用可能なモード: パッケージ
アクセス要件: UPS承認ビジネスについては
テストおよび本番用アクセス
に1つのリクエスト
• D
enied Party Screener API
1つのソースから、米国政府の監視対象である人物を
判断し、最新の正確な政府規制コンプライアンスに
順守します。単一のトランザクションと、異なるマ
ッチ設定を許可することで、名前が付いたパーティ
と目的地の国について、単一ソースの幅広い検索と
チェックを可能にします。さらに、否定についての
特定の理由とリストソースについての特定の理由を
提供します。
• I mport Compliance API
輸入前に、国特有の貿易関係、手順、規制を最大限
遵守して、国境での遅延をなくすようにサポートし
ます。Import Complianceトランザクションの詳細は
保管され、90日間アクセスできます。トランザクシ
ョンは1カ所から1カ所への発送につき、最大99製品
を含むことが可能です。
• E xport License Detector API
目的地の国や輸出分類番号などの商品情報に基づ
いて、最新の米国輸出ライセンス要件にアクセス
し、罰金や制裁のリスクをなくすようにサポート
します。
32
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
国際貿易ビジネスプロセス（続）
UPS TradeAbility API（続）
承認されているビジネスモデル
• エンドユーザー向けの承認
承認されていないビジネスモデル/使用法
• 未
承認サードパーティによるTradeAbility APIのホ
スティングをしてはなりません
API制限
• 統一コードの検索機能を提供してはなりません
• 時代遅れの関税コードと地方の規則
33
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けリ
ソースセンター
UPS開発者向けキット
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
リソースと技術サポー
トへのアクセス
UPS開発者向けキットのユーザーは、UPS開発者向け
リソースセンターを通して、情報にアクセスし、ツー
ルをダウンロードし、技術サポートをリクエストでき
ます。
以下の手順で開発者向けリソースセンターにアクセス
できます。
手順1: ups.comにアクセスします
手順2: サ
ポートタブにマウスを置き、技術サポート
を選択します
手順3: ペ
ージの左にあるナビゲーションパネルで、
リンク開発者向けリソースセンターを選択
します
35
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
リソース
情報にアクセスし、UPS開発者向けリソースセンター
を通してツールとアプリケーションをダウンロード
します。
UPS開発者向けキットソリューション
• 開
発者向けAPI
UPS開発者向けキットのアプリケーションプログラ
ムインターフェース（API）とともに、UPSの機能を
お客様のアプリケーションおよびビジネスシステム
に統合します。
• デ
ータファイルと管理アプリケーション
請求データ情報、請求分析ツール、ups.comから
お客様のコンピュータに自動的にファイルをダウ
ンロードする機能などを備えています。
• U
PS Information Exchange
UPSシステムへ安全にアクセスするためのその他の
ツールとアプリケーションを検索できるほか、PLD
0200 準拠のマニフェストデータをアップロードし
たり、CSVファイルおよびXML(可能な場合)ファイ
ルをダウンロードしたりすることができます。
36
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
技術サポート
UPS開発者向けキットAPIのサポートを得るには4つの
方法があります。すべてはUPS開発者向けリソースセ
ンターを通してアクセスできます。UPS開発者向けリ
ソースセンターへのアクセスに関する指示は、38ペー
ジを参照してください。
UPS開発者向けキットサポート
• U
PS開発者向けキットコミュニティ
これは開発者向けのコミュニティフォーラムで、別
の質問に回答し、情報を共有します。応答時間は変
わる場合があります。
• 電
子メールによる技術サポート（推奨される方法）
これは、技術サポートとAPI統合に関する質問に対す
るサポート方法です。My UPSにログインし、XMLリ
クエスト/応答ファイルと、統合に関する別の適切な
情報を添付することでアクセスできます。UPSの電
子メールによる技術サポートは、XMLリクエスト/応
答ペアのみをサポートします。彼らは、XMLを内部
および購入済みのソフトウェアに統合する方法につ
いては、お客様と開発者に助言できません。
37
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
技術サポート（続）
UPS開発者向けキットサポート（続）
• 一
般的な質問に対する電話サポート
電話サポートは、開発者のための最少の包括的
なサポートメカニズムです。このサポート方法
は、iups.comでユーザーインターフェースについて
の質問と、APIへのアクセス方法に対処し、アクセ
スキーリクエストプロセスに移動します。XMLリク
エスト/応答の問題と質問に対する技術サポートを
提供しません。これらのタイプの質問は、UPS電子
メール技術サポートを経由する必要があります。
• U
PS開発者向けキットの知識ベース
これは、開いたりダウンロード可能な、セルフサー
ビスサポートのPDF資料です。これには、UPS開発
者向けキットAPIによってサポートされるすべての
モードとサービスに関する、よくある質問を240個
以上含みます。また、UPS開発者向けキットコミュ
ニティでは、オンラインバージョンもご用意してい
ます。
38
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
技術サポート（続）
一般的な電子メールによる技術サポート
手順1: 開
発者向けリソースセンターページから、
右のカラムにあるE-mail UPSを選択します。
手順2: 名
前、電子メールアドレスフィールドに記入
し、サポートカテゴリは技術サポートにし
て、サポートトピックは開発者向けリソース
にして、次へをクリックします。
39
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
技術サポート（続）
一般的な電子メールによる技術サポート（続）
手順3: ペ
ージをスクロールダウンし、フォームの残
りに記入します。
– 電話番号
– 開発段階
– 統合するAPIである開発者向けリソース
• XMLリクエスト/応答ペアに添付する添付ファイル
• ［
質問とコメント］「フィールドに問題の適切な説
明を含みます。
• ［電子メールの送信］ボタンを選択します。
40
© 2014 United Parcel Service of America, Inc. All rights reserved.
UPS開発者向けキットユーザーガイド
技術サポート（続）
技術サポートの営業時間
UPSは、統合プロセス中はいつでも、お客様の知りたいこと
を教える方法をたくさん用意しています。UPS開発者向けリ
ソースセンターは、さまざまなサポートオプションを提供し
ます。ups.com/content/jp/ja/resources/techsupport/
developercenter.html
注記: 電子メールのリクエストを送信すると、応答時
間は変わる場合があり、トランザクションと上申によ
ってプロセスが遅延する場合があります。XMLリクエ
スト/応答メッセージおよびエラーを含むファイルを添
付する必要があります。UPSでは可能な限り、24時間
以内に対応いたします。
41
© 2014 United Parcel Service of America, Inc. All rights reserved.