店舗マスタ受注情報取り込み用メールアドレス取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_master_shop/mailaddress

リファレンス内容

受注情報取り込み用メールアドレス取得

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

入力パラメータ

パラメータ	値	省略	備考
`access_token`	access_token取得により取得した値	必須(SDKの場合不要)
`refresh_token`	access_token取得により取得した値	可能(SDKの場合不要)	【指定してaccess_tokenの有効期限が切れた場合】正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます【省略してaccess_tokenの有効期限が切れた場合】出力パラメータ「result」の値がredirectになります
`shop_id`	店舗ID	必須

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`data`	受注情報取り込み用メールアドレスを含んだ情報。`shop_id` と `receiveorder_mail_address` の2フィールドのみ返却。	`fields` パラメータなし、固定2フィールド返却のみ。
`access_token`	入力パラメータで指定したaccess_token／新たに発行されたaccess_token	有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
`access_token_end_date`	access_tokenの有効期限切れ日時（例） 2016-01-01 01:01:01
`refresh_token`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token	access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
`refresh_token_end_date`	refresh_tokenの有効期限切れ日時（例） 2016-01-01 01:01:01

レスポンスデータ（data フィールド）

このエンドポイントは fields パラメータを持たず、以下の2フィールドを固定で返します。

項目名	フィールド名	データ型	備考
店舗ID	`shop_id`	数値型	入力パラメータで指定した店舗ID
受注情報取り込み用メールアドレス	`receiveorder_mail_address`	文字列型

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&shop_id=xxx' https://api.next-engine.org/api_v1_master_shop/mailaddress

レスポンス

{
  "result": "success",
  "data": {
    "shop_id": "1",
    "receiveorder_mail_address": "xxxxxxx@xxxxxxx.xxxxx.xxx"
  },
  "access_token": "xxxxxxxxxxx",
  "access_token_end_date": "2017-04-13 18:24:53",
  "refresh_token": "xxxxxxxxxxx",
  "refresh_token_end_date": "2017-04-15 18:24:53"
}

エラー

エラーコード

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

エラーコード	メッセージ	対処方法
`018001`	アクセス情報[xxxxxx]の許可が必要です。	ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります
`018002`	POSTパラメータにshop_idが指定されていない、または値が空です。	shop_idを指定してください
`018003`	店舗[xxx]は存在しません。	shop_idを確認してください
`018004`	店舗[xxx]は使用停止中の為、情報を取得できません。	メイン機能で店舗の使用を再開してください