コンテンツにスキップ

店舗マスタ店舗接続確認

POST

/api_v1_master_shop/checkconnect

curl -X POST -H 'content-type: application/x-www-form-urlencoded' \
 -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&shop_id=xxx' \
 https://api.next-engine.org/api_v1_master_shop/checkconnect

// POST /api_v1_master_shop/checkconnect - 店舗マスタ店舗接続確認
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/checkconnect', {
  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/checkconnect - 店舗マスタ店舗接続確認
import requests

params = {
    'access_token': '<access_token>',
    'shop_id': '<shop_id>',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_master_shop/checkconnect',
    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 / 接続確認対象の店舗のshop_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

Array<object>

object

shop_id

店舗ID / 数値型

string | integer | number | boolean | null

shop_name

店舗名 / 文字列型

string | integer | number | boolean | null

shop_kana

店舗名カナ / 文字列型

string | integer | number | boolean | null

shop_abbreviated_name

店舗略名 / 文字列型

string | integer | number | boolean | null

shop_handling_goods_name

取扱商品名 / 文字列型

string | integer | number | boolean | null

shop_close_date

閉店日 / 日時型

string | integer | number | boolean | null

shop_note

備考 / 文字列型

string | integer | number | boolean | null

shop_mall_id

モールID / 数値型

string | integer | number | boolean | null

shop_authorization_type_id

オーソリ区分ID / 文字列型

string | integer | number | boolean | null

shop_authorization_type_name

オーソリ区分名 / 文字列型

string | integer | number | boolean | null

shop_tax_id

税区分ID / 文字列型

string | integer | number | boolean | null

shop_tax_name

税区分名 / 文字列型

string | integer | number | boolean | null

shop_currency_unit_id

通貨単位区分ID / 文字列型

string | integer | number | boolean | null

shop_currency_unit_name

通貨単位区分名 / 文字列型

string | integer | number | boolean | null

shop_tax_calculation_sequence_id

税計算順序 / 文字列型 / 0:商品計で税計算,1:単価から税計算

string | integer | number | boolean | null

shop_type_id

後払い.com サイトID / 文字列型

string | integer | number | boolean | null

shop_deleted_flag

削除フラグ / 文字列型

string | integer | number | boolean | null

shop_creation_date

作成日 / 日時型

string | integer | number | boolean | null

shop_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null

shop_last_modified_null_safe_date

最終更新日 / 日時型 / NULLの場合作成日

string | integer | number | boolean | null

shop_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null

shop_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null

shop_last_modified_by_id

最終更新者ID / 数値型

string | integer | number | boolean | null

shop_last_modified_by_null_safe_id

最終更新者ID / 数値型 / NULLの場合作成者ID

string | integer | number | boolean | null

shop_last_modified_by_name

最終更新者名 / 文字列型

string | integer | number | boolean | null

shop_last_modified_by_null_safe_name

最終更新者名 / 文字列型 / NULLの場合作成者名

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "error",
  "code": "012005",
  "message": "FTPユーザ名またはパスワードが違います",
  "request_id": "",
  "access_token": "xxx",
  "access_token_end_date": "2017-04-19 11:21:13",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2017-04-21 11:21:13"
}

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