受注確認内容更新-入出力パラメータ
受注確認内容更新
Section titled “受注確認内容更新”入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります
本機能では、受注確認内容更新の設定値を更新する事のみ可能です(店舗ごとに受注確認内容が有効/無効か設定することは出来ません。)。
入力パラメータ
Section titled “入力パラメータ”| パラメータ | 値 | 省略 | 備考 |
|---|---|---|---|
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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
confirm_id | 受注確認内容ID | 必須 | 更新する受注確認内容のconfirm_id。設定値が有効(confirm_valid_flagが’1’)の受注確認内容のみ指定可能です |
confirm_value | 設定値 | 必須 | 更新する受注確認内容のconfirm_value。値を空に更新することは出来ません |
confirm_last_modified_date | 最終更新日 | 必須 | 更新する店舗のconfirm_last_modified_date API実行時にメイン機能またはアプリで、受注確認内容が更新されていないかを確認するために利用します メイン機能またはアプリで受注確認内容が更新されている場合はエラーになります エラーになったら再度、受注確認内容を検索してAPIを実行して下さい |
出力パラメータ
Section titled “出力パラメータ”| パラメータ名 | 値 | 備考 |
|---|---|---|
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になります |