APIリファレンス

  キャンセルAPI

URL [本番環境] https://<本番URL>/cancel_xml
[テスト環境] https://<ステージングURL>/cancel_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>
	<cancel_type>種別</cancel_type>
	<line_item>
		<line_item_id>注文明細ID</line_item_id>
		<receiver>
			<receiver_id>送付先ID</receiver_id>
		</receiver>
		...(送付先分の<receiver>〜</receiver>)...
	</line_item>
	...(注文明細分の<line_item>〜</line_item>)...
</order>

XMLパラメータ説明

名称 パラメータ 必須   備考
注文 order    
注文ID order_id   キャンセル対象の注文ID
キャンセル種別 cancel_type   キャンセルの種別
0 : 注文すべて 1 : 一部
注文明細 line_item   ※種別が1の場合必須
注文明細ID line_item_id   キャンセル対象の注文明細ID
※種別が1の場合必須
送付先ID一覧 receiver -   省略時は全ての送付先を対象とする
送付先ID receiver_id -   キャンセル対象の送付先ID
PAPIRS(パピルス)はデジタルポスト株式会社が運営する印刷郵送APIを提供しているサービスです

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