宛名面設定API、デザイン面設定APIで設定された宛名面の完成イメージ確認用PDFを返す。
| URL | [本番環境] https://<本番URL>/address_preview_xml [テスト環境] https://<ステージングURL>/address_preview _xml |
| メソッド | POST |
| Content-Type | multipart/form-data |
| リクエストパラメータ | xmlfile - XMLファイル access_token - アクセストークン |
| レスポンス | { "result":"OK", "address_image_url ":"(https://www.digitalpost.jp/xxxxxxxxxxx)" } |
| エラーレスポンス | { "result":"NG", "error_code":"(エラーコード)", "error_message":"(エラー内容)" } |
<?xml version="1.0" encoding="utf-8"?>
<order>
<order_id>注文ID</order_id>
<line_item>
<line_item_id>注文明細ID</line_item_id>
<receiver>
<receiver_id>送付先ID</receiver_id>
</receiver>
...(送付先分の<receiver>〜</receiver>)...
</line_item>
</order>
| 名称 | パラメータ | 必須 | 備考 | |
|---|---|---|---|---|
| 注文 | order | ○ | ||
| 注文ID | order_id | ○ | 確認対象の注文ID | |
| 注文明細 | line_item | ○ | ||
| 注文明細ID | line_item_id | ○ | 確認対象の注文明細ID | |
| 送付先ID一覧 | receiver | - | 省略時は全送付先を対象とする | |
| 送付先ＩＤ | receiver_id | - | 確認対象の送付先ＩＤ |
| 名称 | パラメータ | 備考 | |
|---|---|---|---|
| 宛名面PDFファイルURL | address_image_url | URL | 送付先数分のページ数 |