APIリファレンス

  宛名面設定(CSVファイル)API

注文情報としてその内容を登録する。

URL [本番環境] https://<本番URL>/address_upload_xml
[テスト環境] https://<ステージングURL>/address_upload_xml
メソッド POST
Content-Type multipart/form-data
リクエストパラメータ xmlfile - XMLファイル
access_token - アクセストークン
address_csv_file – 送付先CSVファイル
レスポンス {
  "result":"OK"
}
エラーレスポンス {
  "result":"NG",
  "error_code":"(エラーコード)",
  "error_message":"(エラー内容)"
}

宛名面設定(CSVファイル)用XMLファイル

宛名面設定(CSVファイル)用XMLファイルは下記の内容とする。


<?xml version="1.0" encoding="utf-8"?>
<order>
	<order_id>注文ID</order_id>
	<line_item>
		<line_item_id>注文明細ID</line_item_id>
		<sender>
			<senderid>差出人ID</senderid>
			<company>差出人会社名</company>
			<department>差出人部署名</department>
			<post>差出人役職</post>
			<last_name>差出人姓(必須)</last_name>
			<first_name>差出人名(必須)</first_name>
			<joint_firstname1>差出人連名1</joint_firstname1>
			<joint_firstname2>差出人連名2</joint_firstname2>
			<address_pref>差出人都道府県(必須)</address_pref>
			<address1>差出人市区町村(必須)</address1>
			<address2>差出人町名番地(必須)</address2>
			<address3>差出人建物名</address3>
			<zipcode>差出人郵便番号(7桁)(必須)</zipcode>
		</sender>
	</line_item>
	...(注文明細分の<line_item>〜</line_item>)...
</order>

XMLパラメータ説明

名称 パラメータ 必須   備考
注文 order    
注文ID order_id   連携システムの注文管理番号
注文毎に一意な値を指定する
注文明細 line_item    
注文明細ID line_item_id   連携システムの注文明細管理番号
注文明細毎に一意な値を指定する
差出人情報 sender   宛名面に差出人の入る商品の場合のみ指定
差出人ID sender_id -   連携システムの差出人ID
差出人毎に一意な値を指定する
差出人会社名 company -    
差出人部署名 department -    
差出人役職 post -    
差出人姓 last_name    
差出人名 first_name    
差出人連名1 joint_first_name1 -    
差出人連名2 joint_first_name2 -    
差出人都道府県 address_pref    
差出人市区町村 address1    
差出人町名番地 address2    
差出人建物名 address3 -    
差出人郵便番号 zipcode    

送付先CSVファイル

宛名情報の元となる下記送付先情報をCSVファイルで指定する。

名称 必須 最大文字数 備考
送付先ID 255 送付先毎に一意な値を指定する
50  
50  
敬称 32  
連名1 - 50 会社名、部署名、役職なしの場合のみ有効
連名敬称1 - 32
連名2 - 50
連名敬称2 - 32
連名3 - 50
連名敬称3 - 32
連名4 - 50
連名敬称4 - 32
連名5 - 50
連名敬称5 - 32
会社名 - 255  
部署名 - 255  
役職 - 255  
郵便番号 7 半角数字のみ指定可能
都道府県 64  
市区町村 255  
町名番地 255  
建物名 - 255  
CSVファイルのフォーマットは、SJIS文字列のカンマ区切りとする。必須でない項目は省略可能とする。
1行目のヘッダ行には項目名を指定する。項目名は順不同とする。
2行目以降は、1行目のヘッダ行に指定した項目の値を指定する。

例)
送付先ID,姓,名,敬称,会社名,部署名,役職,郵便番号,都道府県,市区町村,町名番地,建物名
20001,青山,一郎,様,デジポ株式会社,営業部,課長,1070062,東京都,港区,南青山1-10-4,南青山NKビル7F
20002,赤坂,太郎,様,デジポ株式会社,開発部,,1070052,東京都,港区,赤坂8-10-24,住友不動産赤坂ビル 6F

必須項目が省略された行は無視する。
送付先IDが重複する場合、後に記述した行をすべて無視する。
1回の注文で送付先ID1000件まで指定可能とする。送付先IDが1000件を超える場合、エラーとする。
PAPIRS(パピルス)はデジタルポスト株式会社が運営する印刷郵送APIを提供しているサービスです

2011 - 2016 Copyright © Digital POST Co.,Ltd. All Rights Reserved.