受注確認内容更新

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_receiveorder_confirm/update

リファレンス内容

受注確認内容更新

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

出力パラメータ

パラメータ名	値	備考
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になります

サンプル

リクエスト

curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&confirm_id=xxx&confirm_value=xxx&confirm_last_modified_date=xxx' \ https://api.next-engine.org/api_v1_receiveorder_confirm/update

レスポンス

{
  "result": "success",
  "access_token": "xxx",
  "access_token_end_date": "2017-04-18 11:19:26",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2017-04-20 11:19:26"
}

エラー

エラーコード

エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは メッセージコード一覧 を参照してください。

エラーコード	メッセージ	対処方法
017001	アクセス情報[xxxxxx]の許可が必要です。	ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります
017002	POSTパラメータにconfirm_idが指定されていない、または値が空です。	confirm_idを指定してください
017003	POSTパラメータにconfirm_valueが指定されていない、または値が空です。	confirm_valueを指定してください
017004	POSTパラメータにconfirm_last_modified_dateが指定されていません。	confirm_last_modified_dateを指定してください
017005	受注確認内容ID[xx]は、メイン機能に登録されていない値です。	受注確認内容IDを確認してください
017006	受注確認内容ID[xx]は、設定値が設定出来ない受注確認内容です。	設定可能な確認内容IDを指定してください
017007	confirm_last_modified_dateが更新されています。再度受注確認内容を検索してAPIを実行して下さい。	確認内容を再検索して最新の日時を取得してください

関連リンク

• 構造化スキーマビュー: /openapi/operations/api_v1_receiveorder_confirm_update/ (OpenAPI 3.1 のインタラクティブ仕様)
• エラーコード一覧: /guides/param/message/ (result/code/message の意味)
• フィールド一覧: /guides/fields/receiveorder_confirm/ (このエンドポイントが扱うデータ項目)

同じカテゴリの他のエンドポイント (受注確認内容)

• 受注確認内容件数取得 — POST /api_v1_receiveorder_confirm/count
• 受注確認内容検索 — POST /api_v1_receiveorder_confirm/search