注文用XMLファイルを下記のURLに送信すると、Digital POST側で保持している、連携先アカウントの注文情報としてその内容を登録する。
| URL | [本番環境] https://<本番URL>/order_xml [テスト環境] https://<ステージングURL>/order_xml |
| メソッド | POST |
| Content-Type | multipart/form-data |
| リクエストパラメータ | xmlfile - XMLファイル access_token - アクセストークン |
| レスポンス | { "result":"OK", } |
| エラーレスポンス | { "result":"NG", "error_code":"(エラーコード)", "error_message":"(エラー内容)" } |
<?xml version="1.0" encoding="utf-8"?>
<order>
<order_id>注文のID</order_id>
<ship_type>配送方法</ship_type>
<shipping>
<date>発送日</date>
<name>配送先名</name>
<address_pref>配送先都道府県</address_pref>
<address1>配送先市区町村</address1>
<address2>配送先町名番地</address2>
<address3>配送先ビル・マンション名</address3>
<zipcode>配送先郵便番号</zipcode>
<tel>配送先電話番号</tel>
</shipping>
<line_item>
<line_item_id>注文明細ID</line_item_id>
<order_num>注文枚数</order_num>
<address_num>宛名あり枚数</address_num>
<blank_num>宛名なし枚数</blank_num>
</line_item>
...(注文明細分の<line_item>〜</line_item>)...
</order>
| 名称 | パラメータ | 必須 | 備考 | |
|---|---|---|---|---|
| 注文 | order | ○ | ||
| 注文ID | order_id | ○ | 連携システムの注文管理番号 注文毎に一意な値を指定する | |
| 配送方法 | ship_type | ○ | 0 : 宛先直接投函 1 : 一括配送 | |
| 配送先情報 | shipping | △ | ※配送方法が0の場合不要 | |
| 発送日 | date | 最大４５日先まで指定可能 yyyy/mm/dd | ||
| 配送先名 | name | △ | 配送先名 ※配送方法が1の場合必須 | |
| 都道府県 | address_pref | △ | 配送先の都道府県 ※配送方法が1の場合必須 | |
| 市区町村 | address1 | △ | 配送先の市区町村 ※配送方法が1の場合必須 | |
| 町名番地 | address2 | △ | 配送先の町名番地 ※配送方法が1の場合必須 | |
| 建物名 | address3 | 配送先の建物名 | ||
| 郵便番号 | zipcode | △ | 配送先の郵便番号 ※配送方法が1の場合必須 | |
| 電話番号 | tel | △ | 配送先の電話番号 ※配送方法が1の場合必須 | |
| 注文明細 | line_item | ○ | ||
| 注文明細ID | line_item_id | ○ | 連携システムの注文明細管理番号 注文明細毎に一意な値を指定する | |
| 注文枚数 | order_num | ○ | 注文明細単位の枚数 | |
| 宛名あり枚数 | address_num | ○ | 宛名面を印刷するはがき枚数 | |
| 宛名なし枚数 | blank_num | ○ | 宛名面が白紙のはがき枚数 ※配送方法が0の場合0固定 |