close

Enter

Log in using OpenID

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

embedDownload
XML荷物検索データ交換規約
(法人企業版)
Data Exchange Rules
INTERFACE FILE
版数:1.21
2015/6/26
ヤマト運輸株式会社
変更履歴
版数
1
1.00
年月日
2010/9/13
変更内容
1 新規作成
2
1.01
2010/10/27
1 2.データ交換の流れ の注釈の文言を修正
2 3.データ仕様について の応答データの文言を修正
3 4.注意事項 に荷物情報の保存期間と情報取得可能期間について
を追加
3
1.02
2010/11/19
1 【補足】ステータスコード一覧(宅急便) にステータスを追加
4
1.03
2012/1/23
1 3_1.要求データ仕様 の「顧客コード」「顧客コード枝番」「パスワード」
の説明を修正
5
1.04
2012/7/1
1 【補足】ステータスコード一覧(宅急便) にステータスを追加
2 【補足】ステータスコード一覧 (クロネコDM便) にステータスを追加
6
1.05
2012/10/12
1 【補足】ステータスコード一覧(宅急便) にステータスを追加、
「応答対象箇所」の項目を追加
2 【補足】ステータスコード一覧 (クロネコDM便) に
「応答対象箇所」の項目を追加
3 【補足】ステータスコード一覧 (EXP便) に
「応答対象箇所」の項目を追加
7
1.06
2013/6/13
1 【補足】ステータスコード一覧 (EXP便) にステータスを追加
8
1.10
2014/6/20
9
1.20
2015/4/1
1 【補足】ステータスコード一覧(宅急便) のステータスコード14の
表示内容を変更
1 名称を「クロネコDM便」に統一
10
1.21
2015/6/26
1 【補足】ステータスコード一覧(宅急便) にステータスを追加
はじめに
本規約は、ヤマト運輸側と法人企業側とのデータ交換を行う際の仕様を定義
しています。
目次
1.インターフェイス概要
2.データ交換の流れ
3.データ仕様について
3_1.要求データ仕様
3_2.応答データ仕様
4.注意事項
【補足資料】
エラーコード一覧
航空会社対応表
UPS引渡先コード一覧
ステータスコード一覧
要求検索項目-商品マトリクス
1.インターフェイス概要
当インターフェイスは、伝票番号、マルチキー(複数条件)を元に、該当の伝票情報の取得を
可能にするものです。取得可能な伝票情報の区分は、以下になります。
・宅急便 (往復、複数個口のものを含む)
・UPS宅急便
・国際宅急便
・タイムサービス
・EXP便(伝票番号による取得のみ)
・クロネコDM便(伝票番号による取得のみ)
インターフェイスの概要図は以下になります。
SOAP
法人企業
ヤマト運輸
クライアントサービス
XML/APサーバ
(Inter)
クライアントサービス
クライアントサービス
インター
要求データ
インターフェイス概要図
取り扱うインターフェイスは以下になります。
データ名
データ交換方法
データ形式
要求データ
HTTPSリクエスト
XMLデータ
応答データ
HTTPSレスポンス
XMLデータ
備考
※当インターフェイス利用にはインターネットでのSOAP通信が可能であることが条件となります。
※SOAP通信にはSOAPバージョン1.2を使用し、W3Cによって策定された標準に準拠します。
4/27
2.データ交換の流れ
SOAP通信を使用してデータ交換を行います。
当インターフェイスを利用したデータ交換の流れは以下のようになります。
①要求XMLデータ作成
クライアントサービス内で、要求データ(XML)を作成します。
②SOAPリクエスト発行
XML/APサーバーに対しSOAPリクエストを発行します。
呼び出し方法については以下を参照ください。
リクエスト先URL
リクエスト方法
contentType
urn
メソッド名
メソッドに対するパラメータ
https://inter-consistent2.kuronekoyamato.co.jp/consistent2/cts
POST
application/soap+xml; charset=UTF-8
ClientReception
provideXMLTraceService
①にて作成した要求XMLデータをString型のパラメータとする
注)
以下のケースの時、SOAP通信が正常に行われません。
・クライアント端末がインターネット接続不可 (LANケーブル断など)
・XML/APサーバーダウン
クライアントサービス側で、SOAP通信が正しく行われたかを別途チェックしてください。
SOAP通信エラー発生時はクライアント端末のインターネット接続状況をご確認ください。
③SOAPレスポンス取得
SOAPレスポンスから応答XMLデータを取得します。
SOAPレスポンスの取得が成功した場合、レスポンスとして以下の内容が返却されます。
ステータス
ボディ部
200(HTTPリターンコード)
応答XMLデータ
注)
上記以外のステータスが返却された場合、XML/APサーバー内で予期しないエラーが発生
している可能性があります。
クライアントサービス側で、SOAPレスポンス取得時にステータスのチェックを行い、上記以
外のステータスが返却されていた場合、ヤマト運輸へお問い合わせください。
5/27
④SOAPFaultレスポンス取得
SOAPメッセージの処理中においてエラーが発生した場合、以下の内容が返却されます。
Code
Reason
Node
Role
Detail
VersionMismatch,MustUnderstand,DataEncodingUnknown,
Sender,Receiver のいずれか
エラー内容
エラー発生元のURI
エラー発生時点でのノードの役割を示すURI
SOAP本体に関係するアプリケーション固有のエラー情報
注)
上記のエラーが返却された場合、XML/APサーバー内で予期しないエラーが発生している
可能性があります。
クライアントサービス側で、SOAPレスポンス取得時にエラーコードのチェックを行い、上記の
エラーが返却されていた場合、ヤマト運輸へお問い合わせください。
⑤データ取得
③にて取得した応答XMLデータ(ボディ部)から、必要な項目を取得してください。
取得時にクライアントサービス側で必要に応じて適宜データのチェックを行ってください。
※XMLデータの詳細については3章『データ仕様について』を参照ください。
6/27
3.データ仕様について
データ交換時に扱うデータの仕様は以下になります。
データ形式
文字コード
XML Version1.0
UTF-8
各データのイメージは以下のようになります。
(要求データ)
伝票番号検索の場合
<?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</検索キー>
・
検索したい条件(マルチキー)をセットし
ます。
※項目の詳細については『3_1.要求データ仕様』を参照ください。
7/27
(応答データ)
<?xml version="1.0" encoding="UTF-8"?>
<問合せ応答>
<ヘッダ情報>
<検索区分>
・・・
</検索区分>
<届け先情報表示フラグ>
・・・
</届け先情報表示フラグ>
</ヘッダ情報>
<エラー情報>
<エラーコード>02</エラーコード>
<検索条件>999999999999</検索条件>
</エラー情報>
<宅急便データ>
<問い合わせ情報>
<商品情報>
・・・
</商品情報>
・
・
<発送店情報>
・・・
</発送店情報>
<到着店情報>
・・・
</到着店情報>
<作業情報>
・・・
</作業情報>
・
・
<UPS情報>
・・・
</UPS情報>
・
・
<タイムサービス情報>
・・・
</タイムサービス情報>
・
・
<EXP便情報>
・・・
</EXP便情報>
・
・
</問い合わせ情報>
<届け先情報>
<管理キー項目情報>
・・・
</管理キー項目情報>
・
・
エラーの情報についても、他のデータと
同様にタグでくくられます。
伝票番号毎に、データの種類を示すタ
グでくくられます。
各データの種類毎の順番や数につい
ては、要求した荷物情報により可変し
ます。
作業タグについては、新しい情報から
順に並んでいます。最新の情報を取得
したい場合、最初の作業タグ内の情報
を取得してください。
宅急便情報、メール便情報は「発送店
情報」「到着店情報」「作業情報」中に
記載されます。
UPS情報が格納されます。
タイムサービス情報が格納されます。
EXP便情報が格納されます。
※項目の詳細については『3_2.応答データ仕様』を参照ください。
※タグに対応するデータが存在しない場合は、タグのみを設定し応答データを返します。
8/27
3_1.要求データ仕様
項番
1
2
1 2 3
基本情報
4
項目名
5
繰返 属性
IPアドレス
X
顧客コード
X
最大
Byte数
必須
説明
内容サンプル
クライアント端末IPアドレス
IPが以下のようなケースでも、そのままの
100.100.100.100 値をセットする。
『10.10.10.10』
※「10」を「010」へ変換する必要は無い。
15
接続元クライアント
◎
端末のIPアドレス
12
ヤマトビジネスメン
バーズに登録のお
◎ 客様コードのうち、 0424247555
「-(ハイフン)」より前
の部分
3
顧客コード枝番
X
3
4
パスワード
X
12
検索区分
X
2
届け先情報表示フラグ
X
1
備考
ヤマトビジネスメン
バーズに登録のお
客様コードのうち、 001
「-(ハイフン)」より後
の部分
ヤマトビジネスメン
◎ バーズのログインパ
スワード
検索オプション
5
6
検索の種類を表す
01
コード
届け先情報の表示/
1
◎
非表示を示すフラグ
◎
伝票番号検索:01
マルチキー検索:02
表示:1
非表示:0
検索条件
検索区分が01(伝票番号検索)の場合に使
用。
伝票番号検索
7
伝票番号
≦20
X
12
○ 伝票番号
123456789012
マルチキー検索
8
配達指定月日
X
8
時間指定の月日
9
配達指定時間帯
X
4
時間指定の時間範囲1214
10
発送日
X
8
発送日
20100912
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
※
20100913
要求伝票番号
"-"を除いた値をセットする
例)
「1234-5678-9012」 → 「123456789012」
検索区分が02(マルチキー検索)の場合に
使用。
YYYYMMDD
HHHH
発送日の指定がない場合は、
検索日から過去30日間の範囲で検索され
る。
検索キータイトルと検索キーは必ずセット
で
使用。
【属性】
9:1バイトの半角数字
X:1バイトの半角英数字
【必須項目】
◎:検索区分共通の必須項目
○:検索区分01の場合の必須項目
9/27
3_2.応答データ仕様(概要)
応答データの全体構成イメージを以下に示します。
応答データは以下の要素の繰り返しで構成されます。
それぞれのデータの種類毎の並び順や、並ぶ数については、要求した情報により可変になります。
データの種類毎の詳細な内容については3_2.応答データ仕様(詳細)を参照して下さい。
1.伝票番号検索 応答データイメージ
(1)正常時
項目名
項番
1 2 3 4 5
1
ヘッダ情報
2
レコード情報
繰返 属性 必須
説明
内容サンプル
=1
-
検索に関する情報
-
3
宅急便データ
≧0
-
区分が宅急便のデータ
-
4
UPS宅急便データ
≧0
-
区分がUPS宅急便のデータ
-
5
国際宅急便データ
≧0
-
区分が国際宅急便のデータ
-
6
タイムサービスデータ
≧0
-
区分がタイムサービスのデータ
-
7
クロネコDM便
≧0
-
区分がクロネコDM便のデータ
-
8
エキスプレス便
≧0
-
区分がエキスプレス便のデータ
-
繰返 属性 必須
説明
内容サンプル
備考
正常の場合、エラーの場合とも出力され
る。
宅急便データが存在したときに出力され
る。
UPS宅急便データが存在したときに出力さ
れる。
国際宅急便データが存在したときに出力さ
れる。
タイムサービスデータが存在したときに出
力される。
クロネコDM便データが存在したときに出
力される。
エキスプレス便データが存在したときに出
力される。
(2)エラー時
項番
項目名
1
2
3
4
5
備考
1
ヘッダ情報
=1
-
検索に関する情報
-
正常の場合、エラーの場合とも出力され
る。
2
エラー情報
≧0
-
エラーとなったデータの情報
-
エラーデータが存在したときに出力される。
3
レコード情報
4
宅急便データ
≧0
-
区分が宅急便のデータ
-
5
UPS宅急便データ
≧0
-
区分がUPS宅急便のデータ
-
6
国際宅急便データ
≧0
-
区分が国際宅急便のデータ
-
7
タイムサービスデータ
≧0
-
区分がタイムサービスのデータ
-
8
クロネコDM便
≧0
-
区分がクロネコDM便のデータ
-
9
エキスプレス便
≧0
-
区分がエキスプレス便のデータ
-
繰返 属性 必須
説明
内容サンプル
2.マルチキー検索 応答データイメージ
(1)正常時
項目名
項番
1 2 3 4 5
1
ヘッダ情報
2
レコード情報
=1
-
検索に関する情報
-
3
宅急便データ
≧0
-
区分が宅急便のデータ
-
4
UPS宅急便データ
≧0
-
区分がUPS宅急便のデータ
-
5
国際宅急便データ
≧0
-
区分が国際宅急便のデータ
-
6
タイムサービスデータ
≧0
-
区分がタイムサービスのデータ
-
繰返 属性 必須
説明
内容サンプル
(2)エラー時
項番
1
2
項目名
3
4
宅急便データが存在したときに出力され
る。
UPS宅急便データが存在したときに出力さ
れる。
国際宅急便データが存在したときに出力さ
れる。
タイムサービスデータが存在したときに出
力される。
クロネコDM便データが存在したときに出
力される。
エキスプレス便データが存在したときに出
力される。
備考
正常の場合、エラーの場合とも出力され
る。
宅急便データが存在したときに出力され
る。
UPS宅急便データが存在したときに出力さ
れる。
国際宅急便データが存在したときに出力さ
れる。
タイムサービスデータが存在したときに出
力される。
備考
5
1
ヘッダ情報
=1
-
検索に関する情報
-
正常の場合、エラーの場合とも出力され
る。
2
エラー情報
=1
-
エラーとなったデータの情報
-
エラーデータが存在したときに出力される。
10/27
3_2.応答データ仕様 (詳細)
項番
1 2 3 4
ヘッダ情報
項目名
5
繰返 属性 必須
説明
1
検索区分
=1
9
○ 検索の種類を表すコード
2
届け先情報表示フラグ
=1
9
○
エラー情報
内容サンプル
届け先情報の表示/非表示を
示すフラグ
01
伝票番号検索:01
マルチキー検索:02
1
表示:1
非表示:0
エラーの場合に使用。
正常の場合は、エラー情報タグは表示されない。
≧0
3
エラーコード
≧0
9
エラーの種類を表すコード
02
4
検索条件
≧0
X
検索条件
111111111111
5
備考
=1
検索結果情報
≧0
総件数
=1
エラーの場合は、必ずエラーコードが入る。
『【補足】エラーコード一覧』参照
エラーの種類によっては、入らない場合もある。
要求データ内の基本情報項目でエラーとなった場合は、
検索結果情報タグ以降は表示されない。
9
検索結果の総件数
00835
検索区分が02かつ検索結果の総件数が30件以上の場合のみ
表示される。
商品種別により、タグ名にサービス名が入る。
【例】<宅急便データ>、<UPSデータ>、<国際宅急便データ>、
<タイムサービスデータ>、・・・
レコード情報
≦20
or
≦30
マルチキー検索時にエラーとなった場合は、レコード情報タグは表示され
ない。
伝票番号検索の場合は繰返が≦20
マルチキー検索の場合は繰返が≦30
問い合わせ情報
=1
商品情報
=1
01:宅急便 02:UPS/国際宅急便 04:タイムサービス 03:複数口
08:往復宅急便 09:クロネコDM便
6
商品種別
9
○ 商品の種別を表すコード
01
7
伝票番号
X
○ 伝票番号
123456789012
8
個口表示
X
複数口の場合の個口情報
9
本人確認サービス表示
X
本人確認サービスの場合の情
41
報
商品種別が01(宅急便)の場合に使用
伝票種別:51(本人確認サービス発払)の場合、『41』
伝票種別:55(本人確認サービス代引)の場合、『51』
伝票種別:59(本人確認サービスセキュリティーサービス)の場合、『61』
10
配達指定月日
X
時間指定の月日
20100913
YYYYMMDD
11
配達指定時間帯
X
時間指定の時間範囲
1214
HHHH
商品種別が09(クロネコDM便)の場合は、空白データとなる。
12
サイズ品目
K
品目名
宅急便
13
発送店コード
X
発送店となった店所コード
010620
14
出荷表番号
X
出荷管理番号
111111111111
商品種別が09(クロネコDM便)の場合に使用
15
最新ステータス
X
最新のステータス
01
『【補足】ステータスコード一覧』参照
UPS情報
15
=1
・商品種別が03(複数口)の場合に使用
左桁が分子、右桁が分母
【例】1/5(5個口1個目)の場合、『15』
商品種別が02(UPS/国際宅急便)の場合に使用
16
UPS受取サイン
X
UPS商品受取時サイン
kuroneko Taro
17
UPS配達時分
X
UPS商品を輸入後、配達した
時間
1130
18
UPSトラッキング番号
X
UPS側の荷物番号
1Z3R11986745881486
19
UPS輸出入フラグ
X
UPS輸出入フラグ
0
20
UPS引渡先コード
X
国コード
2530
HHMM
0:なし、1:輸出、2:輸入、3:国際宅急便
11/27
3_2.応答データ仕様 (詳細)
項番
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
K
作業を行った店所名
青森市場宅急便センター
26
店名
クロネコDM便情報
=1
商品種別が09(クロネコDM便)の場合に使用
27
重量
X
クロネコDM便の重量
0010
28
通過月日
X
発送店店所を通過した月日
0912
29
通過時刻
X
発送店店所を通過した時刻
1430
到着店情報
宅急便情報
=1
=1
30
データ種別
X
作業内容を表す種別コード
02
02:到着店
31
作業日付
X
作業日付
0912
MMDD
32
作業時間
X
作業時間
0830
HHMM
33
ステータス
X
作業のステータス
01
『【補足】ステータスコード一覧』参照
34
店コード
X
作業を行った店所コード
010620
K
作業を行った店所名
青森市場宅急便センター
35
店名
クロネコDM便情報
=1
商品種別が09(クロネコDM便)の場合に使用
36
重量
X
クロネコDM便の重量
0010
37
通過月日
X
到着店店所を通過した月日
0913
38
通過時刻
X
到着店店所を通過した時刻
0830
作業情報
宅急便情報
検索区分が01(伝票番号検索)の場合に使用
新しい情報から並んでいる
≦5
=1
39
データ種別
X
作業内容を表す種別コード
03
03:履歴1 … 07:履歴5
40
作業日付
X
作業日付
0912
MMDD
41
作業時間
X
作業時間
2210
HHMM
42
ステータス
X
作業のステータス
01
『【補足】ステータスコード一覧』参照
43
店コード
X
作業を行った店所コード
010990
K
作業を行った店所名
青森ベース店
44
店名
クロネコDM便情報
=1
商品種別が09(クロネコDM便)の場合に使用
45
重量
X
クロネコDM便の重量
0010
46
通過月日
X
作業店所を通過した月日
0912
47
通過時刻
X
作業店所を通過した時刻
2210
48
作業日付
X
作業日付
0912
商品種別が04(タイムサービス)の場合に使用
古い情報から並んでいる
MMDD
49
作業時間
X
作業時間
2210
HHMM
50
ステータス
X
作業のステータス
01
『【補足】ステータスコード一覧』参照
51
店コード
X
作業を行った店所コード
010620
K
作業を行った店所名
青森市場宅急便センター
タイムサービス情報
52
≦15
店名
EXP便情報
商品情報
=1
商品種別が07(エキスプレス便)の場合に使用
≦2
53
商品種別
X
商品の種別を表すコード
01
54
伝票番号
X
伝票番号
111111111111
55
売上品目
X
売上品目
2112
56
売上個数
X
売上個数
0001
57
売上重量
X
売上重量
001000
58
最新ステータス
X
最新のステータス
0001
59
作業日付
X
作業日付
0811
60
作業時間
X
作業時間
0130
61
ステータス
X
作業のステータス
0001
62
店コード
X
作業を行った店所コード
010620
K
作業を行った店所名
青森市場宅急便センター
63
店名
子伝票情報
≦29
64
子伝票番号
X
子伝票番号
111111111111
65
子伝票ステータス
X
子伝票のステータス
0001
作業情報
≦11
66
データ種別
X
作業内容を表す種別コード
01
67
作業日付
X
作業日付
0811
68
作業時間
X
作業時間
0130
69
ステータス
X
作業のステータス
0001
70
店コード
X
作業を行った店所コード
010620
71
店名
K
作業を行った店所名
青森市場宅急便センター
12/27
07:エキスプレス便
『【補足】ステータスコード一覧』参照
3_2.応答データ仕様 (詳細)
項番
1
項目名
2 3 4 5
届け先情報
管理キー項目情報
繰返 属性 必須
説明
内容サンプル
=1
=1
72
出荷管理番号
X
出荷管理番号
111111111111
73
検索キータイトル1
K
検索キータイトル1
受注番号
74
検索キー1
X
検索キー1
AA12345678
75
検索キータイトル2
K
検索キータイトル2
お得意様番号
76
検索キー2
X
検索キー2
T0123456
77
検索キータイトル3
K
検索キータイトル3
製品ロット番号
78
検索キー3
X
検索キー3
LLTT1234A
79
検索キータイトル4
K
検索キータイトル4
賞味期限
80
検索キー4
X
検索キー4
20101030
81
検索キータイトル5
K
検索キータイトル5
配達先店舗コード
82
検索キー5
X
検索キー5
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
品名コード1
1234567890
106
品名1
K
品名1
食品
107
品名2
K
品名2
ナマモノ
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
9
コレクト品代金
5800
配達時付帯作業情報
118
=1
コレクト品代金
真荷主情報
備考
要求データの届け先情報表示フラグが1の場合に使用
=1
119
真荷主コード
X
真荷主コード
1111111111
120
真荷主顧客コード
X
真荷主顧客コード
1111111111
【属性】
9:1バイトの半角数字
X:1バイトの半角英数字
【必須項目】
応答データを取得した際、必ず何らかの値
が入力されている項目を示す。
13/27
4.注意事項
4_1.問い合わせ件数について
伝票検索時の一度に問い合わせ可能な件数は20件。
※1
問い合わせ件数が21件以上の場合は、21件以降の伝票番号は
切り捨てられる。
マルチキー検索時の問い合わせ応答可能な件数は30件。
※2
応答データの件数が30件以上となった場合は、上位30件を超えたデータは
応答を返すことが出来ないため、予め検索結果が絞られるような検索条件を
設定することを推奨する。
※3
当インターフェースはリアルタイムに該当荷物情報を応答する目的で使用する。
検索条件が適切でない場合は、検索結果が大量となり、処理に時間が掛かるため
リアルタイムに荷物情報を応答することが困難となる。
そのような状況が続く場合、サーバへの負荷状況を考慮し、要求データの受付を
制限する場合がある。
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
07
08
09
10
11
51
70~99
検索区分
伝票番号検索
伝票番号検索
伝票番号検索
伝票番号検索
共通
共通
共通
マルチキー検索
マルチキー検索
共通
共通
共通
共通
コード説明
伝票番号未入力
伝票番号ホスト未登録
伝票番号誤り
伝票番号未対応
認証エラー
IPアドレス不正
検索オプションエラー
上限値エラー
検索条件エラー
パスワード不正
利用時間外エラー
要求XMLデータ不正
システムエラー
エラー内容
検索要求時に伝票番号が未入力
対象の伝票番号データが未登録
検索要求時に伝票番号が不正な値
対象の伝票番号がサービス対象外
顧客コードとパスワードに認証失敗
検索要求時にIPアドレスが未入力
検索区分、届け先情報表示フラグが不正な値
上限値(100件)を超える検索結果
必須項目未入力、検索条件が不正な値
パスワードが英字または英数字混在4~12文字でない
利用時間外
要求XMLデータのフォーマットが不正
システムエラー
17/27
航空会社対応表
航空会社
航空会社
コード
01
JAL
02
ANA
03
JAS
04
ANK
05
JTA
06
JAC
07
SNA
08
SKY
09
ADO
10
JEX
11
HAC
18/27
UPS引渡先コード
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
国名
アンドラ
アラブ首長国連邦
アンティグア・バーブーダ
アンギラ
アルバニア
蘭領アンチル
アンゴラ
アルゼンチン
米領サモア
オーストリア
オーストラリア
アルバ
アゼルバイジャン
ボスニア・ヘルツェゴビナ
バルバドス
バングラデッシュ
ベルギー
ブルキナファソ
ブルガリア
バーレーン
ブルンジ
ベナン
バーミューダ
ブルネイ
ボリビア
ブラジル
バハマ
ボツワナ
ベラルーシ
ベリーズ
カナダ
チャネル諸島
中央アフリカ共和国
コンゴ
スイス
コートジボワール
クック諸島
チリ
カメルーン
中国
コロンビア
コスタリカ
セルビア・モンテネグロ
カーボヴェルデ
キプロス
チェコ
ドイツ
ジブチ
デンマーク
ドミニカ国
ドミニカ共和国
エクアドル
エストニア
エジプト
エリトリア
スペイン
エチオピア
フィンランド
19/27
UPS引渡先コード
UPS引渡先コード
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
UPS引渡先コード
UPS引渡先コード
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
UPS引渡先コード
UPS引渡先コード
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
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
表示内容
応答対象箇所
商品情報
発送店情報
到着店情報
作業情報
タイムサービス情報
最新ステータス
ステータス
ステータス
ステータス
ステータス
発送
発送
配達中
持戻(ご不在)
持戻(休業)
持戻(住所不明)
持戻(転居)
持戻(受取ご辞退)
調査中
持戻
持戻
配達完了
調査中
配達店到着
調査中
調査中
調査中
保管中
調査中
配達中
配達完了
配達店到着
作業店通過
保管中
保管中
返品
配達完了
通関完了
作業店通過
作業店通過
発送
発送
保管中
調査中
作業店通過
作業店通過
作業店通過
調査中
配達完了
○
○
○
○
○
○
○
○
○
○
○
-
○
○
○
○
○
○
○
○
○
○
○
○
○
○
-
○
○
○
○
○
○
○
-
○
○
○
○
○
○
○
○
○
○
○
○
○
-
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
-
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
-
-
-
-
-
○
○
○
○
○
作業店通過
作業店通過
作業店通過
調査中
調査中
発送
発送
発送
発送
転送/返品
調査中
調査中
(未表示)
(未表示)
調査中
作業店通過
荷物受付
配達予定
ご来店予定(保管中)
配達日・時間帯指定(保管中)
荷物受付
(未表示)
保管中(ご指定店)
返品(持戻保管中)
返品(持戻保管中)
返品(持戻保管中)
配達完了
持戻(ご不在)
作業店到着
溶解完了
調査中
荷物受付
配達店到着
(未表示)
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
-
○
○
○
○
○
-
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
-
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
-
○
○
○
○
-
ステータス
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
表示内容
ステータス
応答対象箇所
商品情報
発送店情報
到着店情報
作業情報
タイムサービス情報
最新ステータス
ステータス
ステータス
ステータス
ステータス
(未表示)
調査中(ご不在)
○
○
○
調査中(住所不明)
○
○
○
調査中(転居先不明)
○
○
○
調査中(受取ご辞退)
○
○
○
(未表示)
転送
○
○
○
返品
○
○
○
返品完了
○
○
(未表示)
(未表示)
(未表示)
(未表示)
(未表示)
宅配ボックスお届け準備
○
○
○
配達完了(宅配ボックス)
○
○
持戻(ご不在)
○
○
○
持戻(ご不在)
○
○
○
(未表示)
(未表示)
お客様引渡完了
○
○
○
持戻(ポスト投函不可)
○
○
○
持戻
○
○
○
※網掛けについては未使用のコード
※応答対象箇所とは、「3_2.応答データ仕様 (詳細)」シートに記載されている
ヘッダ情報のどの部分に該当ステータスが格納されるかを記した一覧です。
「○」は格納される可能性あり、「-」は格納される可能性がないことを表します。
24/27
-
ステータスコード一覧(クロネコDM便)
ステータス
コード
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
40
41
42
43
44
45
46
47
48
49
表示内容
ステータス
投函予定
持戻(休業)
持戻(住所不明)
持戻(転居)
持戻(受取ご辞退)
調査中
持戻
調査中
調査中
調査中
保管中
返品
転送
返品
投函予定
持戻(休業)
持戻(住所不明)
持戻(転居)
持戻(受取ご辞退)
調査中
持戻
投函完了
発送
発送
荷受け
発送
(未表示)
出国
発送
持戻 (ポスト投函不可)
持戻 (ポスト投函不可)
投函予定
(未表示)
調査中
投函予定
返品
返品
返品
返品
応答対象箇所
商品情報
発送店情報
到着店情報
作業情報
最新ステータス
ステータス
ステータス
ステータス
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
-
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
返品
○
○
○
返品
○
○
○
持戻
○
○
○
持戻
○
○
○
返品
○
○
○
(未表示)
(未表示)
(未表示)
(未表示)
※網掛けについては未使用のコード
※応答対象箇所とは、「3_2.応答データ仕様 (詳細)」シートに記載されている
ヘッダ情報のどの部分に該当ステータスが格納されるかを記した一覧です。
「○」は格納される可能性あり、「-」は格納される可能性がないことを表します。
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 配達完了
○
○
0024
0025
0026 転送/返品
○
○
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 伝票番号誤り
○
※網掛けについては未使用のコード
※応答対象箇所とは、「3_2.応答データ仕様 (詳細)」シートに記載されている
ヘッダ情報のどの部分に該当ステータスが格納されるかを記した一覧です。
「○」は格納される可能性あり、「-」は格納される可能性がないことを表します。
26/27
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
-
検索条件-商品マトリクス
○:検索条件として指定可能な項目
商品種別
伝票番号
配達指定月日
配達指定時間帯
発送日
検索キータイトル
検索キー
複数口括りキー
出荷管理番号
お届け先コード
お届け先電話番号
お届け先名
ご依頼主電話番号
ご依頼主名
運賃管理番号
発荷主コード
発荷主名
品名
品名コード
真荷主コード
真荷主顧客コード
国
際
宅
急
便
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
タ
イ
E
ム
X
サ
P
便
ビ
ス
○ ○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
○
ー
検索条件
U
P
宅
S
急
宅
便
急
便
ク
ロ
ネ
コ
D
M
便
○
27/27
Author
Document
Category
Uncategorized
Views
47
File Size
433 KB
Tags
1/--pages
Report inappropriate content