XML荷物検索データ交換規約 (法人企業版)...application/soap+xml; charset=UTF-8 ClientReception provideXMLTraceService ①にて作成した要求XMLデータをString型のパラメータとする

版数：1.262020/3/10

ヤマト運輸株式会社

XML荷物検索データ交換規約(法人企業版)

Data Exchange RulesINTERFACE FILE

変更履歴

1 新規作成

1 2.データ交換の流れの注釈の文言を修正2 3.データ仕様についての応答データの文言を修正3 4.注意事項に荷物情報の保存期間と情報取得可能期間について

を追加

1 【補足】ステータスコード一覧（宅急便）にステータスを追加

1 3_1.要求データ仕様の「顧客コード」「顧客コード枝番」「パスワード」の説明を修正

1 【補足】ステータスコード一覧（宅急便）にステータスを追加2 【補足】ステータスコード一覧 (クロネコＤＭ便) にステータスを追加

1 【補足】ステータスコード一覧（宅急便）にステータスを追加、「応答対象箇所」の項目を追加

2 【補足】ステータスコード一覧 (クロネコＤＭ便) に「応答対象箇所」の項目を追加

3 【補足】ステータスコード一覧 (EXP便) に「応答対象箇所」の項目を追加

1 【補足】ステータスコード一覧 (EXP便) にステータスを追加

1 【補足】ステータスコード一覧（宅急便）のステータスコード14の表示内容を変更

1 名称を「クロネコＤＭ便」に統一

1 【補足】ステータスコード一覧（宅急便）にステータスを追加【補足】ステータスコード一覧 (EXP便)


2 【補足】ステータスコード一覧 (EXP便) のステータスコード0019、0069の表示内容を変更

1 【補足】ステータスコード一覧（宅急便）のステータスコード98のステータスを追加


3 【補足】ステータスコード一覧 (EXP便) のステータスコード0018の表示内容を変更

1 3_1.要求データ仕様のNo.8の表示レイアウトを修正2 3_2.応答データ仕様（詳細）のNo.10の表示レイアウトを修正3 3_1.要求データ仕様のNo.9の内容サンプルを修正4 3_2.応答データ仕様（詳細）のNo.11の内容サンプルを修正5 3_1.要求データ仕様のNo.10の表示レイアウトを追加

1 3_2.応答データ仕様（詳細）のNo.9の備考を修正


15 1.26 2020/3/10

12 1.23 2018/6/4

10 1.21 2015/6/26

1 1.00 2010/9/13

2 1.01 2010/10/27

3 1.02 2010/11/19

4 1.03 2012/1/23

5 1.04 2012/7/1

変更内容

7 1.06 2013/6/13

版数年月日

6 1.05 2012/10/12

8 1.10 2014/6/20

9 1.20 2015/4/1

11 1.22 2017/10/16

13 1.24 2019/2/15

14 1.25 2019/6/16

はじめに

1.インターフェイス概要

2.データ交換の流れ

3.データ仕様について

3_1.要求データ仕様

3_2.応答データ仕様

4.注意事項

【補足資料】

エラーコード一覧

航空会社対応表

UPS引渡先コード一覧

ステータスコード一覧

要求検索項目-商品マトリクス

　本規約は、ヤマト運輸側と法人企業側とのデータ交換を行う際の仕様を定義しています。

目次

1.インターフェイス概要

当インターフェイスは、伝票番号、マルチキー（複数条件）を元に、該当の伝票情報の取得を可能にするものです。取得可能な伝票情報の区分は、以下になります。

・宅急便 (往復、複数個口のものを含む)・UPS宅急便・国際宅急便・タイムサービス・EXP便（伝票番号による取得のみ）・クロネコＤＭ便（伝票番号による取得のみ）

インターフェイスの概要図は以下になります。

取り扱うインターフェイスは以下になります。

要求データ HTTPSリクエスト XMLデータ応答データ HTTPSレスポンス XMLデータ

※当インターフェイス利用にはインターネットでのSOAP通信が可能であることが条件となります。※SOAP通信にはSOAPバージョン1.2を使用し、W3Cによって策定された標準に準拠します。

データ形式データ交換方法データ名備考

インターフェイス概要図

法人企業

クライアントサービス

要求データ



ヤマト運輸

インターネット

XML/APサーバ

（Inter）

SOAP

4/27

2.データ交換の流れ

SOAP通信を使用してデータ交換を行います。当インターフェイスを利用したデータ交換の流れは以下のようになります。

①要求XMLデータ作成クライアントサービス内で、要求データ(XML)を作成します。

②SOAPリクエスト発行XML/APサーバーに対しSOAPリクエストを発行します。呼び出し方法については以下を参照ください。

https://inter-consistent2.kuronekoyamato.co.jp/consistent2/ctsPOSTapplication/soap+xml; charset=UTF-8ClientReceptionprovideXMLTraceService①にて作成した要求XMLデータをString型のパラメータとする

③SOAPレスポンス取得SOAPレスポンスから応答XMLデータを取得します。SOAPレスポンスの取得が成功した場合、レスポンスとして以下の内容が返却されます。

200(HTTPリターンコード)応答XMLデータ

メソッド名メソッドに対するパラメータ

リクエスト先URLリクエスト方法contentType

urn

ステータスボディ部

注）以下のケースの時、SOAP通信が正常に行われません。・クライアント端末がインターネット接続不可 (LANケーブル断など)

・XML/APサーバーダウンクライアントサービス側で、SOAP通信が正しく行われたかを別途チェックしてください。 SOAP通信エラー発生時はクライアント端末のインターネット接続状況をご確認ください。

注）上記以外のステータスが返却された場合、XML/APサーバー内で予期しないエラーが発生している可能性があります。

クライアントサービス側で、SOAPレスポンス取得時にステータスのチェックを行い、上記以外のステータスが返却されていた場合、ヤマト運輸へお問い合わせください。

5/27

https://inter-consistent2.kuronekoyamato.co.jp/consistent2/cts

④SOAPFaultレスポンス取得SOAPメッセージの処理中においてエラーが発生した場合、以下の内容が返却されます。

VersionMismatch,MustUnderstand,DataEncodingUnknown,Sender,Receiver のいずれかエラー内容エラー発生元のURIエラー発生時点でのノードの役割を示すURISOAP本体に関係するアプリケーション固有のエラー情報

⑤データ取得③にて取得した応答XMLデータ（ボディ部）から、必要な項目を取得してください。取得時にクライアントサービス側で必要に応じて適宜データのチェックを行ってください。※XMLデータの詳細については3章『データ仕様について』を参照ください。

Code

Detail

Reason Node Role

注）上記のエラーが返却された場合、XML/APサーバー内で予期しないエラーが発生している可能性があります。

クライアントサービス側で、SOAPレスポンス取得時にエラーコードのチェックを行い、上記のエラーが返却されていた場合、ヤマト運輸へお問い合わせください。

6/27

3.データ仕様について

データ交換時に扱うデータの仕様は以下になります。

XML Version1.0UTF-8

各データのイメージは以下のようになります。

(要求データ)伝票番号検索の場合

マルチキー検索の場合

※項目の詳細については『3_1.要求データ仕様』を参照ください。

データ形式文字コード

<?xml version="1.0" encoding="UTF-8"?> <問合せ要求>

<基本情報> <IPアドレス>100.100.100.100</IPアドレス> <顧客コード>111111111111</顧客コード>

<顧客コード枝番>001</顧客コード枝番> <パスワード>************</パスワード>

</基本情報> <検索オプション> <検索区分>01</検索区分>

<届け先情報表示フラグ>1</届け先情報表示フラグ> </検索オプション>

<検索条件> <伝票番号>111111111111</伝票番号> ・

・・ <伝票番号>999999999999</伝票番号>

</検索条件> </問合せ要求>

情報を要求したい伝票番号をセットします。（最大20件） 20件未満の場合、要求したい伝票番号数分だけタグを設定します。

<?xml version="1.0" encoding="UTF-8"?> <問合せ要求>

<基本情報> <IPアドレス>100.100.100.100</IPアドレス>

<顧客コード>111111111111</顧客コード> <顧客コード枝番>001</顧客コード枝番> <パスワード>************</パスワード>

</基本情報> <検索オプション> <検索区分>02</検索区分>

<届け先情報表示フラグ>1</届け先情報表示フラグ> </検索オプション>

<検索条件> <配達指定月日>0401</配達指定月日> <配達指定時間帯>1800</配達指定時間帯>

<発送日>20090401</発送日> <検索キータイトル>受注番号</検索キータイトル>

<検索キー>AA12345678</検索キー> ・・ </問合せ要求>

検索したい条件（マルチキー）をセットします。

7/27

(応答データ)

※項目の詳細については『3_2.応答データ仕様』を参照ください。※タグに対応するデータが存在しない場合は、タグのみを設定し応答データを返します。

<?xml version="1.0" encoding="UTF-8"?> <問合せ応答> <ヘッダ情報> <検索区分> ・・・ </検索区分> <届け先情報表示フラグ> ・・・ </届け先情報表示フラグ> </ヘッダ情報> <エラー情報> <エラーコード>02</エラーコード> <検索条件>999999999999</検索条件> </エラー情報> <宅急便データ> <問い合わせ情報> <商品情報> ・・・ </商品情報> ・・ <発送店情報> ・・・ </発送店情報> <到着店情報> ・・・ </到着店情報> <作業情報> ・・・ </作業情報> ・・ <UPS情報> ・・・ </UPS情報> ・・ <タイムサービス情報> ・・・ </タイムサービス情報> ・・ <EXP便情報> ・・・ </EXP便情報> ・・ </問い合わせ情報> <届け先情報> <管理キー項目情報> ・・・ </管理キー項目情報> ・・ </届け先情報> </宅急便データ> ・・ </問合せ応答>

タイムサービス情報が格納されます。

EXP便情報が格納されます。

UPS情報が格納されます。

伝票番号毎に、データの種類を示すタグでくくられます。各データの種類毎の順番や数については、要求した荷物情報により可変します。作業タグについては、新しい情報から順に並んでいます。最新の情報を取得したい場合、最初の作業タグ内の情報を取得してください。宅急便情報、メール便情報は「発送店情報」「到着店情報」「作業情報」中に記載されます。

エラーの情報についても、他のデータと同様にタグでくくられます。

8/27

3_1.要求データ仕様

1 2 3 4 5

基本情報

1 IPアドレス X 15 ◎接続元クライアント端末のIPアドレス

100.100.100.100

クライアント端末IPアドレス　IPが以下のようなケースでも、そのままの値をセットする。　『10.10.10.10』　※「10」を「010」へ変換する必要は無い。

2 顧客コード X 12 ◎

ヤマトビジネスメンバーズに登録のお客様コードのうち、「-（ハイフン）」より前の部分

0424247555

3 顧客コード枝番 X 3

ヤマトビジネスメンバーズに登録のお客様コードのうち、「-（ハイフン）」より後の部分

001

4 パスワード X 12 ◎ヤマトビジネスメンバーズのログインパスワード

検索オプション

5 検索区分 X 2 ◎検索の種類を表すコード

01伝票番号検索：01マルチキー検索：02

6 届け先情報表示フラグ X 1 ◎届け先情報の表示/非表示を示すフラグ

1表示：1非表示：0

検索条件

伝票番号検索検索区分が01（伝票番号検索）の場合に使用。

7 伝票番号 ≦20 X 12 ○ 伝票番号 123456789012要求伝票番号　"-"を除いた値をセットする　例）　「1234-5678-9012」 → 「123456789012」

マルチキー検索検索区分が02（マルチキー検索）の場合に使用。

8 配達指定月日 X 4 時間指定の月日 0913 MMDD

9 配達指定時間帯 X 4 時間指定の時間範囲 1416 HHHH

10 発送日 X 8 発送日 20100912

YYYYMMDD発送日の指定がない場合は、検索日から過去30日間の範囲で検索される。

11 検索キータイトル＝1 K 20 検索キータイトル受注番号

12 検索キー＝1 X 20 検索キー AA12345678

13 複数口くくりキー X 20 ※ 複数口くくりキー 123456

14 出荷管理番号 X 23 ※ 出荷管理番号 111111111111

15 お届け先コード X 20 ※ お届け先コード 111111111111

16 お届け先電話番号 X 17 ※ お届け先電話番号 03-1111-1111

17 お届け先名 K 60 ※ お届け先名大和太郎

18 ご依頼主電話番号 X 17 ※ ご依頼主電話番号 03-2222-2222

19 ご依頼主名 K 60 ※ ご依頼主名黒猫次郎

20 発荷主コード X 12 ※ 発荷主コード 0424247555

21 発荷主名 K 50 ※ 発荷主名白猫次郎

22 品名 K 50 品名食品

23 品名コード X 30 品名コード 1234567890

24 真荷主コード X 20 真荷主コード 1111111111

25 真荷主顧客コード X 50 真荷主顧客コード 1111111111

項番項目名

繰返最大Byte数属性

※検索キータイトルと検索キーは必ずセットで使用。

内容サンプル必須備考説明

【属性】

9：1バイトの半角数字 X：1バイトの半角英数字 K：2バイトの全角文字（半角文字混在可）

【必須項目】 ◎：検索区分共通の必須項目 ○：検索区分01の場合の必須項目 ※：検索区分02の場合、いずれかひとつ以上を必須項目とする

9/27

3_2.応答データ仕様（概要）

応答データの全体構成イメージを以下に示します。

応答データは以下の要素の繰り返しで構成されます。それぞれのデータの種類毎の並び順や、並ぶ数については、要求した情報により可変になります。データの種類毎の詳細な内容については3_2.応答データ仕様（詳細）を参照して下さい。

１．伝票番号検索　応答データイメージ（１）正常時

1 2 3 4 5

1 ヘッダ情報＝1 －検索に関する情報－正常の場合、エラーの場合とも出力される。

2 レコード情報

3 宅急便データ ≧0 －区分が宅急便のデータ－宅急便データが存在したときに出力される。

4 UPS宅急便データ ≧0 －区分がUPS宅急便のデータ－UPS宅急便データが存在したときに出力される。

5 国際宅急便データ ≧0 －区分が国際宅急便のデータ－国際宅急便データが存在したときに出力される。

6 タイムサービスデータ ≧0 －区分がタイムサービスのデータ－タイムサービスデータが存在したときに出力される。

7 メール便データ ≧0 －区分がクロネコＤＭ便のデータ－クロネコＤＭ便データが存在したときに出力される。

8 エキスプレス便データ ≧0 －区分がエキスプレス便のデータ－エキスプレス便データが存在したときに出力される。

（２）エラー時

1 2 3 4 5


2 エラー情報 ≧0 －エラーとなったデータの情報－エラーデータが存在したときに出力される。






8 メール便データ ≧0 －区分がクロネコＤＭ便のデータ－クロネコＤＭ便データが存在したときに出力される。

9 エキスプレス便データ ≧0 －区分がエキスプレス便のデータ－エキスプレス便データが存在したときに出力される。

２．マルチキー検索　応答データイメージ（１）正常時

1 2 3 4 5







（２）エラー時

項番繰返属性必須説明内容サンプル備考

1 2 3 4 5


2 エラー情報＝1 －エラーとなったデータの情報－エラーデータが存在したときに出力される。

備考

項目名

必須説明内容サンプル項番項目名

繰返属性

備考

項番項目名

繰返属性内容サンプル備考

必須説明内容サンプル項番項目名

繰返属性

必須説明

10/27

3_2.応答データ仕様 (詳細)

1 2 3 4 5

ヘッダ情報＝1

1 検索区分＝1 9 ○ 検索の種類を表すコード 01伝票番号検索：01マルチキー検索：02

2 届け先情報表示フラグ＝1 9 ○届け先情報の表示/非表示を示すフラグ

1表示：1非表示：0

エラー情報 ≧0エラーの場合に使用。正常の場合は、エラー情報タグは表示されない。

3 エラーコード ≧0 9 エラーの種類を表すコード 02エラーの場合は、必ずエラーコードが入る。『【補足】エラーコード一覧』参照

4 検索条件 ≧0 X 検索条件 111111111111 エラーの種類によっては、入らない場合もある。

検索結果情報 ≧0要求データ内の基本情報項目でエラーとなった場合は、検索結果情報タグ以降は表示されない。

5 総件数＝1 9 検索結果の総件数 00835検索区分が02かつ検索結果の総件数が30件以上の場合のみ表示される。

レコード情報≦20or

≦30

商品種別により、タグ名にサービス名が入る。【例】<宅急便データ>、<UPSデータ>、<国際宅急便データ>、　　　<タイムサービスデータ>、・・・

マルチキー検索時にエラーとなった場合は、レコード情報タグは表示されない。

伝票番号検索の場合は繰返が≦20マルチキー検索の場合は繰返が≦30

問い合わせ情報＝1

商品情報＝1

6 商品種別 9 ○ 商品の種別を表すコード 0101：宅急便 02：UPS/国際宅急便 04：タイムサービス 03：複数口08：往復宅急便 09：クロネコＤＭ便

7 伝票番号 X ○ 伝票番号 123456789012

8 個口表示 X 複数口の場合の個口情報 15・商品種別が03（複数口）の場合に使用左桁が分子、右桁が分母【例】1/5（5個口1個目）の場合、『15』

9 本人確認サービス表示 X本人確認サービスの場合の情報

41商品種別が01(宅急便)の場合に使用伝票種別：51(本人確認サービス発払)の場合、『41』伝票種別：55(本人確認サービス代引)の場合、『51』

10 配達指定月日 X 時間指定の月日 0913 MMDD

11 配達指定時間帯 X 時間指定の時間範囲 1416HHHH商品種別が09（クロネコＤＭ便）の場合は、空白データとなる。

12 サイズ品目 K 品目名宅急便

13 発送店コード X 発送店となった店所コード 010620

14 出荷表番号 X 出荷管理番号 111111111111 商品種別が09（クロネコＤＭ便）の場合に使用

15 最新ステータス X 最新のステータス 01 『【補足】ステータスコード一覧』参照

UPS情報＝1 商品種別が02(UPS/国際宅急便)の場合に使用

16 UPS受取サイン X UPS商品受取時サイン kuroneko Taro

17 UPS配達時分 XUPS商品を輸入後、配達した時間

1130 HHMM

18 UPSトラッキング番号 X UPS側の荷物番号 1Z3R11986745881486

19 UPS輸出入フラグ X UPS輸出入フラグ 0 0：なし、1：輸出、2：輸入、3：国際宅急便

20 UPS引渡先コード X 国コード 2530

備考必須説明内容サンプル項番繰返属性項目名

11/27


1 2 3 4 5備考必須説明内容サンプル項番繰返属性

項目名

発送店情報＝1

宅急便情報＝1

21 データ種別 X 作業内容を表す種別コード 01 01：発送店

22 作業日付 X 作業日付 0912 MMDD

23 作業時間 X 作業時間 1630 HHMM

24 ステータス X 作業のステータス 01 『【補足】ステータスコード一覧』参照

25 店コード X 作業を行った店所コード 010620

26 店名 K 作業を行った店所名青森市場宅急便センター

メール便情報＝1 商品種別が09（クロネコＤＭ便）の場合に使用

27 重量 X クロネコＤＭ便の重量 0010

28 通過月日 X 発送店店所を通過した月日 0912

29 通過時刻 X 発送店店所を通過した時刻 1430

到着店情報＝1

宅急便情報＝1

30 データ種別 X 作業内容を表す種別コード 02 02：到着店








37 通過月日 X 到着店店所を通過した月日 0913

38 通過時刻 X 到着店店所を通過した時刻 0830

作業情報 ≦5検索区分が01（伝票番号検索）の場合に使用新しい情報から並んでいる

宅急便情報＝1

39 データ種別 X 作業内容を表す種別コード 03 03：履歴１ … 07：履歴５





44 店名 K 作業を行った店所名青森ベース店



46 通過月日 X 作業店所を通過した月日 0912

47 通過時刻 X 作業店所を通過した時刻 2210

タイムサービス情報 ≦15商品種別が04(タイムサービス)の場合に使用古い情報から並んでいる






商品情報 ≦2 商品種別が07（エキスプレス便）の場合に使用

53 商品種別 X 商品の種別を表すコード 01 07：エキスプレス便

54 伝票番号 X 伝票番号 111111111111

55 売上品目 X 売上品目 2112

56 売上個数 X 売上個数 0001

57 売上重量 X 売上重量 001000

58 最新ステータス X 最新のステータス 0001

59 作業日付 X 作業日付 0811

60 作業時間 X 作業時間 0130




子伝票情報 ≦29

64 子伝票番号 X 子伝票番号 111111111111

65 子伝票ステータス X 子伝票のステータス 0001

作業情報 ≦11

66 データ種別 X 作業内容を表す種別コード 01

67 作業日付 X 作業日付 0811

68 作業時間 X 作業時間 0130

69 ステータス X 作業のステータス 0001



12/27


1 2 3 4 5備考必須説明内容サンプル項番繰返属性

項目名

届け先情報＝1 要求データの届け先情報表示フラグが1の場合に使用

管理キー項目情報＝1

72 出荷管理番号 X 出荷管理番号 111111111111

73 検索キータイトル1 K 検索キータイトル１受注番号

74 検索キー1 X 検索キー１ AA12345678

75 検索キータイトル2 K 検索キータイトル２お得意様番号

76 検索キー2 X 検索キー２ T0123456

77 検索キータイトル3 K 検索キータイトル３製品ロット番号

78 検索キー3 X 検索キー３ LLTT1234A

79 検索キータイトル4 K 検索キータイトル４賞味期限

80 検索キー4 X 検索キー４ 20101030

81 検索キータイトル5 K 検索キータイトル５配達先店舗コード

82 検索キー5 X 検索キー５ 030600

83 複数口くくりキー X 複数口くくりキー 123456

お届け先情報＝1

84 お届け先コード X お届け先のコード 111111111111

85 お届け先郵便番号 X お届け先の郵便番号 1368675

86 お届け先電話番号 X お届け先の電話番号 03-1111-1111

87 お届け先都道府県 K お届け先の都道府県東京都

88 お届け先市区郡町村名 K お届け先の市区郡町村名江東区

89 お届け先番地 K お届け先の番地南砂2-5-15

90 お届け先建物名 K お届け先の建物名 ○○ビル

91 お届け先名 K お届け先の名前大和太郎

92 お届け先会社名 K お届け先の会社名株式会社○○

93 お届け先部門名 K お届け先の部門名総務部

ご依頼主情報＝1

94 ご依頼主郵便番号 X ご依頼主の郵便番号 1368675

95 ご依頼主電話番号 X ご依頼主の電話番号 03-1111-1111

96 ご依頼主都道府県 K ご依頼主の都道府県東京都

97 ご依頼主市区郡町村名 K ご依頼主の市区郡町村名江東区

98 ご依頼主番地 K ご依頼主の番地南砂2-5-15

99 ご依頼主建物名 K ご依頼主の建物名 ○○ビル

100 ご依頼主名 K ご依頼主の名前大和太郎

101 ご依頼主会社名 K ご依頼主の会社名株式会社○○

102 ご依頼主部門名 K ご依頼主の部門名総務部

発荷主情報＝1

103 発荷主コード X 発荷主コード 0424247555

104 発荷主名 K 発荷主名大和太郎

品名情報＝1

105 品名コード1 X 品名コード１ 1234567890

106 品名1 K 品名１食品

107 品名2 K 品名２ナマモノ

108 複数口2個目品名 K 複数口の場合の2個目の品名テレビ

109 複数口3個目品名 K 複数口の場合の3個目の品名パソコン

110 複数口4個目品名 K 複数口の場合の4個目の品名掃除機

111 複数口5個目品名 K 複数口の場合の5個目の品名洗濯機

貨物取扱い情報＝1

112 温度区分 X 温度区分 1

113 出荷予定日 X 出荷予定日 20090101

114 配達指定日 X 配達指定日 0101

115 配達指定時間帯 X 配達指定時間帯 0812

116 伝票種別 X 伝票種別 111111111111

117 発送日 X 発送日 20090401

配達時付帯作業情報＝1

118 コレクト品代金 9 コレクト品代金 5800

真荷主情報＝1

119 真荷主コード X 真荷主コード 1111111111

120 真荷主顧客コード X 真荷主顧客コード 1111111111

【属性】

9：1バイトの半角数字

X：1バイトの半角英数字 K：2バイトの全角文字（半角文字混在可）

【必須項目】応答データを取得した際、必ず何らかの値が入力されている項目を示す。

13/27

4.注意事項

4_1.問い合わせ件数について伝票検索時の一度に問い合わせ可能な件数は20件。※１問い合わせ件数が21件以上の場合は、21件以降の伝票番号は切り捨てられる。

マルチキー検索時の問い合わせ応答可能な件数は30件。※２応答データの件数が30件以上となった場合は、上位30件を超えたデータは応答を返すことが出来ないため、予め検索結果が絞られるような検索条件を設定することを推奨する。

※３当インターフェースはリアルタイムに該当荷物情報を応答する目的で使用する。検索条件が適切でない場合は、検索結果が大量となり、処理に時間が掛かるためリアルタイムに荷物情報を応答することが困難となる。そのような状況が続く場合、サーバへの負荷状況を考慮し、要求データの受付を制限する場合がある。

4_2.応答データについて伝票番号検索の場合、要求データで指定した伝票番号に該当する応答データが取得可能となる。

マルチキー検索の場合、検索条件に該当するデータの中から、要求データで指定した顧客コード、顧客コード枝番に該当する応答データのみ取得可能となる。（要求データで指定した顧客コード、顧客コード枝番以外のデータは取得できない。）

4_3.届け先情報についてマルチキー検索の場合、届け先情報を検索条件として要求データに設定可能となるが届け先情報表示フラグをOFF(0)で要求すると、要求データに設定した条件の情報が応答データでは確認不可となる。

届け先情報については、要求データで指定した顧客コード、顧客コード枝番に該当する届け先情報のみ取得可能となる。他顧客の届け先情報は、取得することが出来ない。

4_4.作業情報について作業情報は伝票番号検索を行った場合のみ取得可能となる。　マルチキー検索時は、途中履歴は表示されず、最新ステータス情報のみ取得可能となる。

4_5.問い合わせ間隔について要求に対する応答が返ってから次の要求を発行する。要求を発行する場合は前の応答から5秒以上のインターバルをおく。

4_6.サービス利用時間についてサービス利用時間は7時～23時とする。ただし、届け先情報表示フラグがOFFの状態で伝票番号検索を行う場合は24時間利用可能となる。

14/27

4_7.荷物情報の保存期間と情報取得可能期間について荷物情報の保存期間と情報取得可能期間は、いずれも90日間とする。

4_8.免責

4_8_1.当社のインターフェースのご利用について　このデータ交換規約は当社の提供するインターフェースに関しての規約です。本章でソフトウエアとは、当社の提供するインターフェースです。　なお、お客様がこれらを利用して自ら開発することができますが、お客様がそうしたインターフェースを利用して自ら開発したシステムについては、お客様が一切の責任を負うことになります。

　 4_8_2.利用上の制約について　当社は、お客様への通知を行うことなく、自己の裁量に基づいていつでもソフトウエアや特定の機能に関して利用の制約（たとえば、ソフトウエアを介して当社のサービスへのアクセス回数、アクセス時間などについて制限することなど）を行うことができるものとします。　また、ソフトウエアに関するサポートや修正版（アップデート版を含みます）の提供は、当社の裁量に基づいて行い、またあらかじめお客様へ通知を行うことなく、それらを終了する場合があります。

4_8_3.禁止行為について本サービスのご利用に際し、次に掲げる行為を禁止します。 ①営利目的で利用する行為 ②不正にアクセスする行為 ③不正なデータを送受信する行為 ④管理及び運営を妨害する行為 ⑤改変、改造、再配布する行為 ⑥公序良俗に反するサイトで利用する行為 ⑦その他当社が不適切と判断する行為

4_8_4.保証について　当社は提供するインターフェースについて、エラーやバグ、論理的誤り、不具合、中断その他の瑕疵（かし）がないこと、信頼性、正確性、完全性、有効性について一切保証しておりません。インターフェースは明示または黙示の有無にかかわらず、当社がその提供時において保有する状態で提供するものであり、特定の目的への適合性、有用性（有益性）、セキュリティ、権原および非侵害性について一切保証しておりません。

本ソフトウェアをご使用になりますと、お客様は上記事項に同意されたものとみなされます。

15/27

補足　XMLトレースデータの検索における各項目の関係を以下に示す。

16/27

エラーコード一覧

エラーコード検索区分コード説明エラー内容01 伝票番号検索伝票番号未入力検索要求時に伝票番号が未入力02 伝票番号検索伝票番号ホスト未登録対象の伝票番号データが未登録03 伝票番号検索伝票番号誤り検索要求時に伝票番号が不正な値04 伝票番号検索伝票番号未対応対象の伝票番号がサービス対象外05 共通認証エラー顧客コードとパスワードに認証失敗06 共通 IPアドレス不正検索要求時にIPアドレスが未入力07 共通検索オプションエラー検索区分、届け先情報表示フラグが不正な値08 マルチキー検索上限値エラー上限値（100件）を超える検索結果09 マルチキー検索検索条件エラー必須項目未入力、検索条件が不正な値10 共通パスワード不正パスワードが英字または英数字混在4～12文字でない11 共通利用時間外エラー利用時間外51 共通要求XMLデータ不正要求XMLデータのフォーマットが不正

70～99 共通システムエラーシステムエラー

17/27

航空会社対応表航空会社

コード航空会社

01 JAL02 ANA03 JAS04 ANK05 JTA06 JAC07 SNA08 SKY09 ADO10 JEX11 HAC

18/27

UPS引渡先コード

4144 アンドラ4145 アラブ首長国連邦4147 アンティグア・バーブーダ4149 アンギラ414C アルバニア414E 蘭領アンチル414F アンゴラ4152 アルゼンチン4153 米領サモア4154 オーストリア4155 オーストラリア4157 アルバ415A アゼルバイジャン4241 ボスニア・ヘルツェゴビナ4242 バルバドス4244 バングラデッシュ4245 ベルギー4246 ブルキナファソ4247 ブルガリア4248 バーレーン4249 ブルンジ424A ベナン424D バーミューダ424E ブルネイ424F ボリビア4252 ブラジル4253 バハマ4257 ボツワナ4259 ベラルーシ425A ベリーズ4341 カナダ4344 チャネル諸島4346 中央アフリカ共和国4347 コンゴ4348 スイス4349 コートジボワール434B クック諸島434C チリ434D カメルーン434E 中国434F コロンビア4352 コスタリカ4353 セルビア・モンテネグロ4356 カーボヴェルデ4359 キプロス435A チェコ4445 ドイツ444A ジブチ444B デンマーク444D ドミニカ国444F ドミニカ共和国4543 エクアドル4545 エストニア4547 エジプト4552 エリトリア4553 スペイン4554 エチオピア4649 フィンランド

国名UPS引渡先コード

19/27



464A フィジー464D ミクロネシア連邦464F フェロー諸島4652 フランス4741 ガボン4742 イギリス4744 グレナダ4745 グルジア4746 仏領ギアナ4748 ガーナ4749 ジブラルタル474C グリーンランド474D ガンビア474E ギニア4750 グアドループ島4751 赤道ギニア4752 ギリシャ4754 グアテマラ4755 グアム4759 ガイアナ484B 香港484E ホンジュラス4852 クロアチア4854 ハイチ4855 ハンガリー4943 カナリヤ諸島4944 インドネシア4945 アイルランド494C イスラエル494E インド4953 アイスランド4954 イタリア4A4D ジャマイカ4A4F ヨルダン4B45 ケニア4B48 カンボジア4B49 キリバス4B4E セントキャッツ＆ネービス4B52 韓国4B57 クウェート4B59 ケイマン諸島4B5A カザフスタン4C41 ラオス4C42 レバノン4C43 セントルシア4C49 リヒテンシュタイン4C4B スリランカ4C53 レソト4C54 リトアニア4C55 ルクセンブルグ4C56 ラトビア4D41 モロッコ4D43 モナコ4D44 モルドバ4D47 マダガスカル4D48 マーシャル諸島4D4B マケドニア4D4C マリ

20/27



4D4E モンゴル4D4F マカオ4D50 サイパン4D51 マルチニク4D52 モーリタニア4D53 モントセラト4D54 マルタ4D55 モーリシャス4D56 モルディブ4D57 マラウイ4D58 メキシコ4D59 マレーシア4D5A モザンビーク4E41 ナミビア4E43 ニューカレドニア4E45 ニジェール4E47 ナイジェリア4E49 ニカラグア4E4C オランダ4E4F ノルウェー4E50 ネパール4E5A ニュージーランド4F4D オマーン5041 パナマ5045 ペルー5046 タヒチ5047 パプアニューギニア5048 フィリピン504B パキスタン504C ポーランド5052 プエルトリコ5054 ポルトガル5057 パラオ5059 パラグアイ5141 カタール5245 レユニオン524F ルーマニア5255 ロシア5257 ルワンダ5341 サウジアラビア5342 ソロモン諸島5343 セーシェル5345 スウェーデン5347 シンガポール5349 スロベニア共和国534B スロバキア534C シエラレオネ534D サンマリノ534E セネガル5352 スリナム5356 エルサルバドル5359 シリア535A スワジランド5443 タ－クス＆カイコス諸島5444 チャド5447 トーゴ5448 タイ544A タジキスタン

21/27



544D トルクメニスタン544E チュニジア544F トンガ5452 トルコ5454 トリニダード・トバゴ5456 ツバル5457 台湾545A タンザニア5541 ウクライナ5547 ウガンダ5553 アメリカ5559 ウルグアイ555A ウズベキスタン5643 ｾﾝﾄﾋﾞﾝｾﾝﾄ＆ｸﾞﾚﾅﾃﾞｨｰﾝ諸島5645 ベネズエラ5647 英領バージン諸島5649 米領バージン諸島564E ベトナム5655 バヌアツ5746 ワリス＆フツナ諸島5753 西サモア5945 イエメン5A41 南アフリカ共和国5A4D ザンビア5A57 ジンバブエ4B47 キルギス4146 アフガニスタン445A アルジェリア414D アルメニア4951 イラク4747 ガーンジー島4757 ギニアビサウ5253 セルビア544C 東ティモール4254 ブータン4D45 モンテネグロ4C59 リビア4C52 リベリア4A45 ジャージー島

22/27

ステータスコード一覧（宅急便）表示内容応答対象箇所

商品情報発送店情報到着店情報作業情報タイムサービス情報

最新ステータスステータスステータスステータスステータス

01 発送 ○ ○ - - -02 発送 ○ ○ - - -03 配達中 ○ - ○ ○ -04 持戻（ご不在） ○ - ○ ○ -05 持戻（休業） ○ - ○ ○ -06 持戻（住所不明） ○ - ○ ○ -07 持戻（転居） ○ - ○ ○ -08 持戻（受取ご辞退） ○ - ○ ○ -09 調査中 ○ - ○ ○ -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 配達完了 - - - - ○4041 作業店通過 - - - - ○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 （未表示） - - - - -

ステータスコードステータス

23/27

ステータスコード一覧（宅急便）表示内容応答対象箇所

商品情報発送店情報到着店情報作業情報タイムサービス情報

最新ステータスステータスステータスステータスステータス


75 （未表示） - - - - -76 調査中（ご不在） ○ - ○ ○ -77 調査中（住所不明） ○ - ○ ○ -78 調査中（転居先不明） ○ - ○ ○ -79 調査中（受取ご辞退） ○ - ○ ○ -80 （未表示） - - - - -81 転送 ○ - ○ ○ -82 返品 ○ - ○ ○ -83 返品完了 ○ - ○ - -84 （未表示） - - - - -85 （未表示） - - - - -86 （未表示） - - - - -87 （未表示） - - - - -88 （未表示） - - - - -89 宅配ボックスお届け準備 ○ - ○ ○ -90 配達完了（宅配ボックス） ○ - ○ - -91 持戻（ご不在） ○ - ○ ○ -92 持戻（ご不在） ○ - ○ ○ -93 （未表示） - - - - -94 （未表示） - - - - -95 お客様引渡完了 ○ - ○ ○ -96 持戻（ポスト投函不可） ○ - ○ ○ -97 持戻 ○ - ○ ○ -98 持ち出し中 ○ - ○ ○ -

※網掛けについては未使用のコード※応答対象箇所とは、「3_2.応答データ仕様 (詳細)」シートに記載されている　ヘッダ情報のどの部分に該当ステータスが格納されるかを記した一覧です。　「○」は格納される可能性あり、「-」は格納される可能性がないことを表します。

24/27

ステータスコード一覧（クロネコＤＭ便）表示内容応答対象箇所

商品情報発送店情報到着店情報作業情報

最新ステータスステータスステータスステータス

01 投函予定 ○ - ○ ○02 持戻（休業） ○ - ○ ○03 持戻（住所不明） ○ - ○ ○04 持戻（転居） ○ - ○ ○05 持戻（受取ご辞退） ○ - ○ ○06 調査中 ○ - ○ ○07 持戻 ○ - ○ ○08 調査中 ○ - ○ ○09 調査中 ○ - ○ ○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 返品 ○ - ○ ○4041 返品 ○ - ○ ○42 返品 ○ - ○ ○43 持戻 ○ - ○ ○44 持戻 ○ - ○ ○45 返品 ○ - ○ ○46 （未表示） - - - -47 （未表示） - - - -48 （未表示） - - - -49 （未表示） - - - -



25/27

ステータスコード一覧（EXP便）表示内容応答対象箇所

商品情報子伝票情報作業情報

最新ステータスステータス子伝票ステータスステータス

0001 発送 ○ ○ ○ -0002 発送 ○ ○ ○ -0003 発送 ○ ○ ○ -0004 ご不在(持戻保管中） ○ - ○ ○0005 休業（持戻保管中） ○ - ○ ○0006 住所不明(持戻保管中） ○ - ○ ○0007 転居（持戻保管中） ○ - ○ ○0008 受取ご辞退（持戻保管中） ○ - ○ ○0009 調査中 ○ - ○ ○0010 持戻 ○ - ○ ○0011 持戻 ○ - ○ ○0012 配達完了 ○ - ○ ○0013 調査中 ○ - ○ ○0014 調査中 ○ - ○ ○0015 調査中 ○ - ○ ○0016 調査中 ○ - ○ ○0017 調査中 ○ - ○ ○0018 配達担当営業所保管中 ○ - ○ ○0019 保管中 ○ - ○ ○0020 調査中 ○ - ○ ○0021 作業店通過 ○ - ○ ○0022 作業店通過 ○ - ○ ○0023 配達完了 ○ - ○ ○002400250026 転送／返品 ○ - ○ ○0027 配達予定 ○ - ○ ○0028 ご来店予定（保管中） ○ - ○ ○0029 配達日・時間帯指定（保管中） ○ - ○ ○0030 調査中 ○ - ○ ○0031 発送 ○ ○ ○ -0032 発送 ○ ○ ○ -0033 配達中 ○ - ○ ○0034 通過 ○ - ○ ○0035 通過 ○ - ○ ○0036 通過 ○ - ○ ○0037 通過 ○ - ○ ○0038 通過 ○ - ○ ○0053 発送 ○ ○ ○ -0054 ご不在(持戻保管中） ○ - ○ ○0055 休業（持戻保管中） ○ - ○ ○0056 住所不明(持戻保管中） ○ - ○ ○0057 転居（持戻保管中） ○ - ○ ○0058 受取ご辞退（持戻保管中） ○ - ○ ○0059 調査中 ○ - ○ ○0060 持戻 ○ - ○ ○0061 持戻 ○ - ○ ○0062 配達完了 ○ - ○ ○0063 調査中 ○ - ○ ○0064 調査中 ○ - ○ ○0065 調査中 ○ - ○ ○0066 調査中 ○ - ○ ○0067 調査中 ○ - ○ ○0068 保管中 ○ - ○ ○0069 保管中 ○ - ○ ○0070 調査中 ○ - ○ ○0072 調査中 ○ - ○ ○0073 調査中 ○ - ○ ○0077 配達予定 ○ - ○ ○0078 ご来店予定（保管中） ○ - ○ ○0079 配達日・時間帯指定（保管中） ○ - ○ ○0080 調査中 ○ - ○ ○0082 発送 ○ ○ ○ -0083 配達中 ○ - ○ ○0084 調査中 ○ - ○ ○0085 調査中 ○ - ○ ○0086 通過 ○ - ○ ○0087 通過 ○ - ○ ○0088 通過 ○ - ○ ○0089 作業店通過 ○ - ○ ○0100 伝票番号未登録 ○ - - -0101 伝票番号誤り ○ - - -



26/27

検索条件-商品マトリクス○：検索条件として指定可能な項目

宅急便

UPS宅急便

国際宅急便

タイムサービス

EXP便

クロネコＤＭ便

伝票番号 ○ ○ ○ ○ ○ ○

配達指定月日 ○ ○ ○ ○

配達指定時間帯 ○ ○ ○ ○

発送日 ○ ○ ○ ○

検索キータイトル ○ ○ ○ ○

検索キー ○ ○ ○ ○

複数口括りキー ○ ○ ○ ○

出荷管理番号 ○ ○ ○ ○

お届け先コード ○ ○ ○ ○

お届け先電話番号 ○ ○ ○ ○

お届け先名 ○ ○ ○ ○

ご依頼主電話番号 ○ ○ ○ ○

ご依頼主名 ○ ○ ○ ○

運賃管理番号 ○ ○ ○ ○

発荷主コード ○ ○ ○ ○

発荷主名 ○ ○ ○ ○

品名 ○ ○ ○ ○

品名コード ○ ○ ○ ○

真荷主コード ○ ○ ○ ○

真荷主顧客コード ○ ○ ○ ○

検索条件

商品種別

27/27

Documents

XML荷物検索データ交換規約 (法人企業版)...application/soap+xml; charset=UTF-8 ClientReception provideXMLTraceService ①にて作成した要求XMLデータをString型のパラメータとする