コンテンツにスキップ

配送情報出力済み-入出力パラメータ

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

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

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

パラメータ省略備考
access_tokenaccess_token取得により取得した値必須(SDKの場合不要)
refresh_tokenaccess_token取得により取得した値可能(SDKの場合不要)【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります(成功時以外の出力パラメータ参照)
wait_flag1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却可能(省略時は1以外とする)詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
receive_order_id伝票番号必須配送情報出力済みにする受注の伝票番号
receive_order_last_modified_date最終更新日必須配送情報出力済みにする受注の最終更新日。 API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します。 メイン機能またはアプリで受注伝票が更新されている場合はエラーになります。 エラーになったら再度、受注伝票を検索してAPIを実行して下さい。
receive_order_label_print_flagラベル発行フラグ1:配送情報出力対象にする2:配送情報出力済みにするパラメータが無い場合は「2:配送情報出力済みにする」として処理します。
パラメータ名備考
resultsuccesssuccess以外の場合の出力パラメータは成功時以外の出力パラメータ参照
access_token入力パラメータで指定したaccess_token/新たに発行されたaccess_token有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
refresh_token入力パラメータで指定したrefresh_token/新たに発行されたrefresh_tokenaccess_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります

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

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