配送情報出力済み

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

有効な受注伝票の配送情報ステータスを出力済みにします。

処理結果はレスポンスのステータスコードで確認します。

入力パラメータ

パラメータ 省略 備考
access_token access_token取得により取得した値 必須(SDKの場合不要)
refresh_token access_token取得により取得した値 可能(SDKの場合不要) 【指定してaccess_tokenの有効期限が切れた場合】

正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます

【省略してaccess_tokenの有効期限が切れた場合】

出力パラメータ「result」の値がredirectになります(成功時以外の出力パラメータ参照)
wait_flag 1:メイン機能過負荷でも可能な限りエラーにせず実行
1以外:メイン機能過負荷の場合、003002のエラーを返却
可能(省略時は1以外とする) 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
receive_order_id 伝票番号 必須 配送情報出力済みにする受注の伝票番号
receive_order_last_modified_date 最終更新日 必須 配送情報出力済みにする受注の最終更新日。

API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します。

メイン機能またはアプリで受注伝票が更新されている場合はエラーになります。

エラーになったら再度、受注伝票を検索してAPIを実行して下さい。
receive_order_label_print_flag ラベル発行フラグ 1:配送情報出力対象にする
2:配送情報出力済みにする

パラメータが無い場合は「2:配送情報出力済みにする」として処理します。

出力パラメータ

パラメータ名 備考
result success success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
access_token 入力パラメータで指定したaccess_token/新たに発行されたaccess_token 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
refresh_token 入力パラメータで指定したrefresh_token/新たに発行されたrefresh_token access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります

出力済みにできる条件

以下は受注伝票の項目になります。

項目名 フィールド名 条件
伝票番号 receive_order_id メイン機能に存在する受注伝票
受注キャンセル区分 receive_order_cancel_type_id 0:キャンセルされていない有効な受注伝票
ラベル発行フラグ receive_order_label_print_flag 0:配送情報出力対象にする
1:配送情報出力済みにする