APIリファレンス

  宛名面設定API

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

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

宛名面設定用XMLファイル

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


<?xml version="1.0" encoding="utf-8"?>
<order>
	<order_id>注文ID</order_id>
	<line_item>
		<line_item_id>注文明細ID</line_item_id>
		<sender>
			<sender_id>差出人ID</sender_id>
			<company>差出人会社名</company>
			<department>差出人部署名</department>
			<post>差出人役職</post>
			<last_name>差出人姓(必須)</last_name>
			<first_name>差出人名(必須)</first_name>
			<joint_first_name1>差出人連名1</joint_first_name1>
			<joint_first_name2>差出人連名2</joint_first_name2>
			<address_pref>差出人都道府県(必須)</address_pref>
			<address1>差出人市区町村(必須)</address1>
			<address2>差出人町名番地(必須)</address2>
			<address3>差出人ビル・マンション名</address3>
			<zipcode>差出人郵便番号(7桁)(必須)</zipcode>
		</sender>
		<receiver>
			<receiver_id>送付先ID</receiver_id>
			<company>送付先1会社名</company>
			<department>送付先1部署名</department>
			<post>送付先1役職</post>
			<last_name>送付先1姓(必須)</last_name>
			<first_name>送付先1名(必須)</first_name>
			<honorific>送付先1敬称(必須)</honorific>
			<joint_first_name1>送付先1連名1</joint_first_name1>
			<joint_honorific1>送付先1敬称1</joint_honorific1>
			<joint_first_name2>送付先1連名2</joint_first_name2>
			<joint_honorific2>送付先1敬称2</joint_honorific2>
			<joint_first_name3>送付先1連名3</joint_first_name3>
			<joint_honorific3>送付先1敬称3</joint_honorific3>
			<joint_first_name4>送付先1連名4</joint_first_name4>
			<joint_honorific4>送付先1敬称4</joint_honorific4>
			<joint_first_name5>送付先1連名5</joint_first_name5>
			<joint_honorific5>送付先1敬称5</joint_honorific5>
			<address_pref>送付先1都道府県(必須)</address_pref>
			<address1>送付先1市区町村(必須)</address1>
			<address2>送付先1町名番地(必須)</address2>
			<address3>送付先1ビル・マンション名</address3>
			<zipcode>送付先1郵便番号(7桁)(必須)</zipcode>
		</receiver>
		...(送付先分の<receiver>〜</receiver>)...
	</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_name1 -    
差出人連名2 joint_name2 -    
差出人都道府県 address_pref    
差出人市区町村 address1    
差出人町名番地 address2    
差出人建物名 address3 -    
差出人郵便番号 zipcode    
送付先情報(n) receiver    
送付先(n)ID receiver_id   連携システムの宛先ID
送付先毎に一意な値を指定する
送付先(n)会社名 company -    
送付先(n)部署名 department -    
送付先(n)役職 post -    
送付先(n)姓 last_name    
送付先(n)名 first_name    
送付先(n)敬称 honorific    
送付先(n)連名1 joint_first_name1 -    
送付先(n)連名敬称1 joint_honorific1 -    
送付先(n)連名2 joint_first_name2 -    
送付先(n)連名敬称2 joint_honorific2 -    
送付先(n)連名3 joint_first_name3 -    
送付先(n)連名敬称3 joint_honorific3 -    
送付先(n)連名4 joint_first_name4 -    
送付先(n)連名敬称4 joint_honorific4 -    
送付先(n)連名5 joint_first_name5 -    
送付先(n)連名敬称5 joint_honorific5 -    
送付先(n)都道府県 address_pref    
送付先(n)市区町村 address1    
送付先(n)町名番地 address2    
送付先(n)建物名 address3 -    
送付先(n)郵便番号 zipcode    
PAPIRS(パピルス)はデジタルポスト株式会社が運営する印刷郵送APIを提供しているサービスです

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