APIリファレンス

  注文状態確認API

URL [本番環境] https://<本番URL>/status_xm
[テスト環境] https://<ステージングURL>/status_xml
メソッド POST
Content-Type multipart/form-data
リクエストパラメータ xmlfile - XMLファイル
access_token - アクセストークン
レスポンス {
  "result":"OK",
  "status_code":"(ステータスコード)",
  "tracking_number": "(追跡番号)", ※一括配送注文のステータスコードが投函済(T01T003)の場合のみ
  "ordered_date":"(注文受付日時)",
  "posting_date":"(発送予定日時)",
  "printing_date":"(印刷開始日時)",
  "posted_date":"(発送完了日時)",
  "canceled_date":"(キャンセル日時)"
}
エラーレスポンス {
  "result":"NG",
  "error_code":"(エラーコード)",
  "error_message":"(エラー内容)"
}

ステータスコード

ステータスコード 注文状態詳細
T01T001注文受付済
T01T002印刷中
T01T003発送済
T01T009キャンセル済

注文状態確認用XMLファイル

注文状態確認用XMLファイルは下記の内容とする。


<?xml version="1.0" encoding="utf-8"?>
<order>
	<order_id>注文ID</order_id>
	<line_item>
		<line_item_id>注文明細ID</line_item_id>
	</line_item>
</order>

XMLパラメータ

名称 パラメータ 必須   説明
注文 order    
注文ID order_id   状態確認対象の注文ID
注文明細 line_item    
注文明細ID line_item_id   状態確認対象の注文明細ID

レスポンスパラメータ説明

名称 パラメータ   備考
注文受付日時 ordered_date   yyyy/MM/dd HH:mm
発送予定日時 posting_date   yyyy/MM/dd HH:mm
印刷開始日時 printing_date   yyyy/MM/dd HH:mm
発送完了日時 posted_date   yyyy/MM/dd HH:mm
キャンセル日時 canceled_date   yyyy/MM/dd HH:mm
PAPIRS(パピルス)はデジタルポスト株式会社が運営する印刷郵送APIを提供しているサービスです

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