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

POST

/api_v1_master_shop/mailaddress

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

// POST /api_v1_master_shop/mailaddress - 店舗マスタ受注情報取り込み用メールアドレス取得
const params = new URLSearchParams({
  access_token: '<access_token>',
  shop_id: '<shop_id>',
})
const res = await fetch('https://api.next-engine.org/api_v1_master_shop/mailaddress', {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)

# POST /api_v1_master_shop/mailaddress - 店舗マスタ受注情報取り込み用メールアドレス取得
import requests

params = {
    'access_token': '<access_token>',
    'shop_id': '<shop_id>',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_master_shop/mailaddress',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

application/x-www-form-urlencoded

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

shop_id

required

店舗ID

string

Responses

200

実行結果 (result が success / error / redirect のいずれか)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

data

object

shop_id

店舗ID / 数値型 / 入力パラメータで指定した店舗ID

string | integer | number | boolean | null

receiveorder_mail_address

受注情報取り込み用メールアドレス / 文字列型

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "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"
}

4XX

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

{
  "result": "success"
}

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

Request Bodyrequired

Responses

200

Example

4XX

Example

Request Body^required