# 店舗マスタ — ネクストエンジン API

> 店舗マスタ カテゴリの API endpoint (6 件) を集約したファイル。
> インデックス: https://developer.next-engine.com/llms.txt | 全文: https://developer.next-engine.com/llms-full.txt

---

# 店舗マスタ件数取得
URL: https://developer.next-engine.com/api/api_v1_master_shop/count/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_master_shop/count
Tag: 店舗マスタ
Required parameters: access_token
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_master_shop/count`

## リファレンス内容


### 件数取得について

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

検索条件を複数指定した場合、全ての条件がかつ(AND)となります

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
| `access_token_end_date` | access_tokenの有効期限切れ日時 | |
| `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |
| `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | |
| `count` | 検索結果の件数 | |


### 店舗マスタ

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗ID | `shop_id` | 数値型 | |
| 店舗名 | `shop_name` | 文字列型 | |
| 店舗名カナ | `shop_kana` | 文字列型 | |
| 店舗略名 | `shop_abbreviated_name` | 文字列型 | |
| 取扱商品名 | `shop_handling_goods_name` | 文字列型 | |
| 閉店日 | `shop_close_date` | 日時型 | |
| 備考 | `shop_note` | 文字列型 | |
| モールID | `shop_mall_id` | 数値型 | |
| オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | |
| オーソリ区分名 | `shop_authorization_type_name` | 文字列型 | |
| 税区分ID | `shop_tax_id` | 文字列型 | |
| 税区分名 | `shop_tax_name` | 文字列型 | |
| 通貨単位区分ID | `shop_currency_unit_id` | 文字列型 | |
| 通貨単位区分名 | `shop_currency_unit_name` | 文字列型 | |
| 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 0:商品計で税計算,1:単価から税計算 |
| 後払い.com サイトID | `shop_type_id` | 文字列型 | |
| 削除フラグ | `shop_deleted_flag` | 文字列型 | |
| 作成日 | `shop_creation_date` | 日時型 | |
| 最終更新日 | `shop_last_modified_date` | 日時型 | |
| 最終更新日 | `shop_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `shop_creator_id` | 数値型 | |
| 作成担当者名 | `shop_creator_name` | 文字列型 | |
| 最終更新者ID | `shop_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `shop_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `shop_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `shop_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


 サンプル
### サンプル

リクエスト

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

レスポンス

```json
{
  "result": "success",
  "count": "xxx",
  "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"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードはありません。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

## 関連リンク

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

### 同じカテゴリの他のエンドポイント (店舗マスタ)

- [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect`
- [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create`
- [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress`
- [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search`
- [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update`

---

# 店舗マスタ検索
URL: https://developer.next-engine.com/api/api_v1_master_shop/search/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_master_shop/search
Tag: 店舗マスタ
Required parameters: access_token
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_master_shop/search`

## リファレンス内容


### 検索について

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

検索条件を複数指定した場合、全ての条件がかつ(AND)となります

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します |
| フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します |
| `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ |
| `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
| `access_token_end_date` | access_tokenの有効期限切れ日時 | |
| `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |
| `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | |
| `count` | 検索結果の件数 | |
| `data` | 検索結果の連想配列(JSONのオブジェクト型) | |

### 検索速度について

入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります

検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい

大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します


### 店舗マスタ

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗ID | `shop_id` | 数値型 | |
| 店舗名 | `shop_name` | 文字列型 | |
| 店舗名カナ | `shop_kana` | 文字列型 | |
| 店舗略名 | `shop_abbreviated_name` | 文字列型 | |
| 取扱商品名 | `shop_handling_goods_name` | 文字列型 | |
| 閉店日 | `shop_close_date` | 日時型 | |
| 備考 | `shop_note` | 文字列型 | |
| モールID | `shop_mall_id` | 数値型 | |
| オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | |
| オーソリ区分名 | `shop_authorization_type_name` | 文字列型 | |
| 税区分ID | `shop_tax_id` | 文字列型 | |
| 税区分名 | `shop_tax_name` | 文字列型 | |
| 通貨単位区分ID | `shop_currency_unit_id` | 文字列型 | |
| 通貨単位区分名 | `shop_currency_unit_name` | 文字列型 | |
| 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 0:商品計で税計算,1:単価から税計算 |
| 後払い.com サイトID | `shop_type_id` | 文字列型 | |
| 削除フラグ | `shop_deleted_flag` | 文字列型 | |
| 作成日 | `shop_creation_date` | 日時型 | |
| 最終更新日 | `shop_last_modified_date` | 日時型 | |
| 最終更新日 | `shop_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `shop_creator_id` | 数値型 | |
| 作成担当者名 | `shop_creator_name` | 文字列型 | |
| 最終更新者ID | `shop_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `shop_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `shop_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `shop_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


### モール/カート

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| モール/カートID | `mall_id` | 数値型 | |
| モール/カート名 | `mall_name` | 文字列型 | |
| モール/カートカナ | `mall_kana` | 文字列型 | |
| 備考 | `mall_note` | 文字列型 | |
| 国ID | `mall_country_id` | 文字列型 | |
| 削除フラグ | `mall_deleted_flag` | 文字列型 | |


 サンプル
### サンプル

リクエスト

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

レスポンス

```json
{
  "result": "success",
  "count": "1",
  "data": [
    {
      "shop_id": "1",
      "shop_name": "Test01",
      "shop_kana": "",
      "shop_abbreviated_name": "tst1",
      "shop_handling_goods_name": null,
      "shop_close_date": null,
      "shop_note": "",
      "shop_mall_id": "1",
      "shop_authorization_type_id": "0",
      "shop_authorization_type_name": null,
      "shop_tax_id": "0",
      "shop_tax_name": "税込",
      "shop_currency_unit_id": "1",
      "shop_currency_unit_name": "円",
      "shop_tax_calculation_sequence_id": "1",
      "shop_type_id": null,
      "shop_deleted_flag": "0",
      "shop_creation_date": "2016-12-19 18:04:03",
      "shop_last_modified_date": "2016-12-19 18:04:03",
      "shop_last_modified_null_safe_date": "2016-12-19 18:04:03",
      "shop_creator_id": "2",
      "shop_creator_name": "xxx",
      "shop_last_modified_by_id": "2",
      "shop_last_modified_by_null_safe_id": "2",
      "shop_last_modified_by_name": "xxx",
      "shop_last_modified_by_null_safe_name": "xxx"
    }
  ],
  "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"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードはありません。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

## 関連リンク

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

### 同じカテゴリの他のエンドポイント (店舗マスタ)

- [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect`
- [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count`
- [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create`
- [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress`
- [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update`

---

# 店舗マスタ受注情報取り込み用メールアドレス取得
URL: https://developer.next-engine.com/api/api_v1_master_shop/mailaddress/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_master_shop/mailaddress
Tag: 店舗マスタ
Required parameters: access_token, shop_id
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエスト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` | 文字列型 | |


 サンプル
### サンプル

リクエスト

```bash
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
```

レスポンス

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


## エラー

### エラーコード

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

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

## 関連リンク

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

### 同じカテゴリの他のエンドポイント (店舗マスタ)

- [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect`
- [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count`
- [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create`
- [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search`
- [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update`

---

# 店舗マスタ店舗更新
URL: https://developer.next-engine.com/api/api_v1_master_shop/update/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_master_shop/update
Tag: 店舗マスタ
Required parameters: access_token, shop_id, shop_last_modified_date, data
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_master_shop/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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `shop_id` | 店舗ID | 必須 | 更新する店舗のshop_id |
| `shop_last_modified_date` | 最終更新日 | 必須 | 更新する店舗のshop_last_modified_date API実行時にメイン機能またはアプリで、店舗が更新されていないかを確認するために利用します メイン機能またはアプリで店舗が更新されている場合はエラーになります エラーになったら再度、店舗を検索してAPIを実行して下さい |
| `data` | 作成する店舗情報のXML | 必須 | 詳細はこちらを参照 |

### 出力パラメータ

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

### XML形式

入力パラメータのdataで指定する値です 
[店舗作成](/api/param/create_shop#xml)と同じです。更新可能なフィールドのみ異なります

XMLサンプル

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <shop>
 <shop_kana>ラクテン</shop_kana>
 </shop>
</root>
```

### 更新仕様

APIで指定できるフィールドの一覧です

ここに記載されていないフィールドは指定できません

#### 店舗情報

| 項目名 | フィールド名 | データ型 | 値必須 | 備考 |
| --- | --- | --- | --- | --- |
| 店舗名 | `shop_name` | 文字列型 | ○ | |
| 店舗略名 | `shop_abbreviated_name` | 文字列型 | ○ | |
| 店舗カナ | `shop_kana` | 文字列型 | | |
| 備考 | `shop_note` | 文字列型 | | |
| 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | |
| 税区分ID | `shop_tax_id` | 文字列型 | ○ | 税区分のIDを指定します |
| 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | ○ | 0:商品計で税計算, 1:単価から税計算 |
| 通貨単位ID | `shop_currency_unit_id` | 文字列型 | ○ | 通貨単位のIDを指定します |
| オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | オーソリ区分のIDを指定します |
| ログインID_1 | `mall_login_id1` | 文字列型 | | 各ログインID/パスワードはモール/カートの種類により扱いが異なります。詳細は店舗作成のログインID/パスワードの扱いを参照下さい これらの項目は検索することは出来ませんが、接続確認することで正しい値か確認することが出来ます |
| ログインID_2 | `mall_login_id2` | 文字列型 | |
| ログインID_3 | `mall_login_id3` | 文字列型 | |
| パスワード_1 | `mall_password1` | 文字列型 | |
| パスワード_2 | `mall_password2` | 文字列型 | |
| パスワード_3 | `mall_password3` | 文字列型 | |
| インボイス形式を適用 | `shop_enabled_invoice` | 文字列型 | | 1:適用する1以外:適用しない省略時:変更しない |
| ヤマト請求先顧客コード | `claim_id_yamato` | 文字列型 | | |
| 西濃荷送人コード | `claim_id_seinou` | 文字列型 | | |
| 福山荷送人コード | `claim_id_fukuyama` | 文字列型 | | |
| 後払い.com サイトID | `shop_type_id` | 文字列型 | | |


### サンプル

リクエスト

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

レスポンス

```json
{
  "result": "success",
  "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"
}
```


## エラー

### エラーコード

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

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `014001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `014002` | POSTパラメータにshop_idが指定されていない、または値が空です。 | shop_idを指定してください |
| `014003` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください |
| `014004` | POSTパラメータにshop_last_modified_dateが指定されておりません。 | shop_last_modified_dateを指定してください |
| `014005` | 店舗[_xxx_]は存在しません。 | shop_idを確認してください |
| `014006` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | XMLの形式を修正してください |
| `014007` | dataにshopタグが設定されておりません。 | shopタグを設定してください |
| `014008` | [_xxxxxx_]タグを指定する場合、値が必須です。 | タグ xxxxxx に値を設定してください |
| `014009` | [_xxxxxx_]タグは指定出来ません。 | タグ xxxxxx は指定できません |
| `014010` | shopタグにネストしたタグを設定することは出来ません。 | shopタグのネストは指定できません |
| `014011` | 更新フィールドが設定されておりません。 | 更新するフィールドを設定してください |
| `014012` | _xxxxxx_[_xxxxxxxxxxxx_]は、メイン機能に登録されていない値です。 | フィールド xxxxxx の値を確認してください |
| `014013` | shop_tax_calculation_sequence_id[_xxx_]には0又は1を設定して下さい。 | 0または1の値を設定してください |
| `014014` | shop_last_modified_dateが更新されています。再度店舗を検索してAPIを実行して下さい。 | 店舗を再検索して最新の日時を取得してください |

## 関連リンク

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

### 同じカテゴリの他のエンドポイント (店舗マスタ)

- [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect`
- [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count`
- [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create`
- [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress`
- [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search`

---

# 店舗マスタ店舗作成
URL: https://developer.next-engine.com/api/api_v1_master_shop/create/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_master_shop/create
Tag: 店舗マスタ
Required parameters: access_token, data
Optional parameters: refresh_token, wait_flag, fields, offset, limit, test_flag

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_master_shop/create`

## リファレンス内容


### 店舗作成

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

動作はメイン機能の店舗追加と同じです

【注意】メイン機能は50店舗まで作成可能ですが、一度登録した店舗は削除出来ません。開発時はチェックのみ実施するtest_flagを1にしてご利用下さい。店舗数が50になってしまった場合はこちらを確認下さい

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `test_flag` | 1:テスト, 1以外:通常 | 0(通常) | テストの場合、入力チェックのみ実施し店舗を登録しません。作成したshop_idは固定で1を返却します |
| `data` | 作成する店舗情報のXML | 必須 | 詳細はこちらを参照 |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
| `access_token_end_date` | access_tokenの有効期限切れ日時 | |
| `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |
| `refresh_token_end_date` | refresh_tokenの有効期限切れ日時 | |
| `shop_id` | 登録した店舗のID | |

### XML形式

入力パラメータのdataで指定する値です 
サンプルはこちらを参照

| 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 |
| --- | --- | --- | --- | --- | --- |
| 1 | <root> | ○ | | | |
| 2 | <shop> | ○ | | | 店舗情報の親タグ |
| 3 | <xxxxxxxxx> | ○ | | | 作成する店舗のフィールド名と値を指定します必須ではないフィールドは、タグ自体を省略することも可能です(値が空欄の場合と同じ挙動になります) |
| 2 | </shop> | ○ | | | |
| 1 | </root> | ○ | | | |

XMLサンプル

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <shop>
 <shop_mall_id>1</shop_mall_id>
 <shop_name>楽天店</shop_name>
 <shop_abbreviated_name>raku</shop_abbreviated_name>
 <shop_kana></shop_kana>
 <shop_note></shop_note>
 <shop_handling_goods_name>スマホグッズ</shop_handling_goods_name>
 <shop_tax_id>1</shop_tax_id>
 <shop_tax_calculation_sequence_id>1</shop_tax_calculation_sequence_id>
 <shop_currency_unit_id>1</shop_currency_unit_id>
 <shop_authorization_type_id></shop_authorization_type_id>
 <mall_login_id1>login_id</mall_login_id1>
 <mall_login_id2></mall_login_id2>
 <mall_login_id3></mall_login_id3>
 <mall_password1>password</mall_password1>
 <mall_password2></mall_password2>
 <mall_password3></mall_password3>
 <shop_type_id></shop_type_id>
 <default_delivery_id>13</default_delivery_id>
 </shop>
</root>
```

### 作成仕様

APIで指定できるフィールドの一覧です

ここに記載されていないフィールドは指定できません

#### 店舗情報

| 項目名 | フィールド名 | データ型 | 省略 | 備考 |
| --- | --- | --- | --- | --- |
| モール/カートID | `shop_mall_id` | 数値型 | 必須 | モール/カートのIDを指定します。この項目は更新時に指定出来ません |
| 店舗名 | `shop_name` | 文字列型 | 必須 | |
| 店舗略名 | `shop_abbreviated_name` | 文字列型 | 必須 | |
| 店舗カナ | `shop_kana` | 文字列型 | | |
| 備考 | `shop_note` | 文字列型 | | |
| 取扱商品名 | `shop_handling_goods_name` | 文字列型 | | |
| 税区分ID | `shop_tax_id` | 文字列型 | 必須 | 税区分のIDを指定します |
| 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 必須 | 0:商品計で税計算, 1:単価から税計算 |
| 通貨単位ID | `shop_currency_unit_id` | 文字列型 | 必須 | 通貨単位のIDを指定します |
| オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | | オーソリ区分のIDを指定します |
| ログインID_1 | `mall_login_id1` | 文字列型 | | 各ログインID/パスワードはモール/カートの種類により扱いが異なります。詳細はこちらを参照下さい これらの項目は検索することは出来ませんが、接続確認することで正しい値か確認することが出来ます |
| ログインID_2 | `mall_login_id2` | 文字列型 | |
| ログインID_3 | `mall_login_id3` | 文字列型 | |
| パスワード_1 | `mall_password1` | 文字列型 | |
| パスワード_2 | `mall_password2` | 文字列型 | |
| パスワード_3 | `mall_password3` | 文字列型 | |
| インボイス形式を適用 | `shop_enabled_invoice` | 文字列型 | | 1:適用する1以外:適用しない省略時:適用しない |
| 規定の発送方法ID | `default_delivery_id` | 文字列型 | | 発送方法区分のIDを指定します。この項目は更新時に指定出来ません。また「21:ヤマト(コレクト)B2v6」、「25:ヤマト(コレクト)B2v5」、「36:楽天コンビニ受取(ゆうパック)」は規定の発送方法に対応していないため、指定しても規定の発送方法が登録されません |
| 後払い.com サイトID | `shop_type_id` | 文字列型 | | |

#### ログインID/パスワードの扱い

| モール/カートID | モール/カート名 | フィールド名 : 項目名 | 備考 |
| --- | --- | --- | --- |
| 1 | 楽天市場 | mall_login_id2 : SMTP AUTH ID mall_password2 : SMTP AUTH password mall_login_id3 : FTP用 ID mall_password3 : FTP用 password | |
| 2 | Yahoo!ショッピング | mall_login_id1 : ストアアカウント(API使用時にのみ登録) mall_password1 : リクエストURL(API使用時にのみ登録) mall_login_id2 : 認証キー(API使用時にのみ登録) mall_login_id3 : FTPアカウント mall_password3 : FTPパスワード | |
| 3 | DeNAショッピング | mall_login_id1 : ID mall_password1 : password | |
| 7 | 電脳卸 | 利用しません | |
| 8 | 電話FAX | 利用しません | |
| 11 | amazon（プロマーチャント） | mall_login_id1 : Eメールアドレス mall_password1 : パスワード mall_login_id2 : 【MWSアカウント】出品者 ID mall_login_id3 : 【MWSアカウント】マーケットプレイス ID | |
| 13 | おちゃのこネット | mall_login_id1 : ログインID mall_password1 : password mall_login_id3 : 管理画面URL | |
| 14 | ショップサーブ | mall_login_id1 : ショップID password : mall_password1 mall_login_id2 : 管理画面URL | |
| 15 | ヤフオク!ストア | mall_login_id1 : Yahoo! JAPANビジネスID mall_password1 : password mall_login_id2 : YahooJapanID mall_password2 : password | |
| 19 | `FutureShop2` | mall_login_id1 : FTPユーザ mall_password1 : password mall_login_id2 : ホスト名 | |
| 20 | `ZenCartPro-R` | mall_login_id1 : 在庫更新実行URL mall_login_id2 : FTPホスト名 mall_password2 : 読み込み対象ディレクトリ mall_login_id3 : FTP用 ID mall_password3 : FTP用 password | |
| 21 | `EC-CUBE` | mall_login_id1 : 在庫更新用URL mall_password1 : ご利用のバージョンを入力してください。例：2.13.1 | |
| 22 | カラーミーショップ | mall_login_id1 : ログインID mall_password1 : password | |
| 23 | スーパーデリバリー | mall_login_id1 : ログインID mall_password1 : password | |
| 25 | マーキュリー | mall_password2 : FTPホスト mall_login_id3 : FTPアカウント mall_password3 : FTPパスワード | |
| 26 | `WiseCart` | mall_login_id1 : ショップID | |
| 28 | DeNA BtoB market | mall_login_id1 : ログインID mall_password1 : password | |
| 30 | ぐるなび食市場 | mall_login_id1 : ID mall_password1 : password | |
| 31 | `aiship` | mall_login_id1 : ID mall_password1 : password mall_login_id2 : 管理者用ログイン画面URL | |
| 32 | `BuyersClub` | mall_login_id2 : 企業ID | |
| 33 | Qoo10(Gmarket) | mall_login_id1 : IDまたはメール mall_password1 : password | |
| 35 | MakeShop & NEカート | mall_login_id1 : ショップID mall_password1 : password | |
| 40 | `SHOPLIST` | mall_login_id1 : 在庫更新用URL mall_password1 : ストアアカウント 認証キー : mall_login_id2 | |
| 41 | 楽天B2B | mall_login_id1 : FTP用 ユーザ mall_password1 : FTP用 password | |
| 42 | ポンパレモール | mall_login_id1 : ショップログインID mall_password1 : ショップパスワード | |
| 90 | 汎用 | mall_login_id1 : 在庫更新用URL mall_password1 : ストアアカウント mall_login_id2 : 認証キー mall_login_id3 : Ver.1の場合 : 空文字を指定、Ver.2の場合: 2を指定 | |
| 91 | 卸 | 利用しません | |

### 店舗数が最大になってしまった場合

開発環境：リカバリすることは出来ませんが、[013011]のエラー(店舗数のチェック)が最後のチェックになっております。このエラーになる場合は、本番環境では登録が成功します

本番環境：お手数ですが弊社まで問い合わせするよう回答をお願いします


### 店舗マスタ

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗ID | `shop_id` | 数値型 | |
| 店舗名 | `shop_name` | 文字列型 | |
| 店舗名カナ | `shop_kana` | 文字列型 | |
| 店舗略名 | `shop_abbreviated_name` | 文字列型 | |
| 取扱商品名 | `shop_handling_goods_name` | 文字列型 | |
| 閉店日 | `shop_close_date` | 日時型 | |
| 備考 | `shop_note` | 文字列型 | |
| モールID | `shop_mall_id` | 数値型 | |
| オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | |
| オーソリ区分名 | `shop_authorization_type_name` | 文字列型 | |
| 税区分ID | `shop_tax_id` | 文字列型 | |
| 税区分名 | `shop_tax_name` | 文字列型 | |
| 通貨単位区分ID | `shop_currency_unit_id` | 文字列型 | |
| 通貨単位区分名 | `shop_currency_unit_name` | 文字列型 | |
| 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 0:商品計で税計算,1:単価から税計算 |
| 後払い.com サイトID | `shop_type_id` | 文字列型 | |
| 削除フラグ | `shop_deleted_flag` | 文字列型 | |
| 作成日 | `shop_creation_date` | 日時型 | |
| 最終更新日 | `shop_last_modified_date` | 日時型 | |
| 最終更新日 | `shop_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `shop_creator_id` | 数値型 | |
| 作成担当者名 | `shop_creator_name` | 文字列型 | |
| 最終更新者ID | `shop_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `shop_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `shop_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `shop_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


 サンプル
### サンプル

リクエスト

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

レスポンス

```json
{
  "result": "success",
  "shop_id": "xxx",
  "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"
}
```


## エラー

### エラーコード

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

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `013001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `013002` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください |
| `013003` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | XMLの形式を修正してください |
| `013004` | dataにshopタグが設定されておりません。 | shopタグを設定してください |
| `013005` | 必須の[_xxxxxx_]タグが設定されておりません。 | 必須タグ xxxxxx を設定してください |
| `013006` | 必須の[_xxxxxx_]タグの値が設定されておりません。 | 必須タグ xxxxxx に値を設定してください |
| `013007` | [_xxxxxx_]タグは指定出来ません。 | タグ xxxxxx は指定できません |
| `013008` | shopタグにネストしたタグを設定することは出来ません。 | shopタグのネストは指定できません |
| `013009` | _xxxxxx_[_xxxxxxxxx_]は、メイン機能に登録されていない値です。 | フィールド xxxxxx の値を確認してください |
| `013010` | shop_tax_calculation_sequence_id[_xxx_]には0又は1を設定して下さい。 | 0または1の値を設定してください |
| `013011` | 店舗は50件まで登録可能です。 | 店舗数が上限に達しています。お問い合わせください |
| `013012` | shop_hit_syohin_alert_flag[xxxxx]には0又は1を設定して下さい。 | 0または1の値を設定してください |

## 関連リンク

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

### 同じカテゴリの他のエンドポイント (店舗マスタ)

- [店舗マスタ店舗接続確認](/api/api_v1_master_shop/checkconnect/) — `POST /api_v1_master_shop/checkconnect`
- [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count`
- [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress`
- [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search`
- [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update`

---

# 店舗マスタ店舗接続確認
URL: https://developer.next-engine.com/api/api_v1_master_shop/checkconnect/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_master_shop/checkconnect
Tag: 店舗マスタ
Required parameters: access_token, shop_id
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_master_shop/checkconnect`

## リファレンス内容


### 店舗接続確認

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

動作はメイン機能の店舗の接続確認と同じです

接続に成功した場合はresultがsuccessになります

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `shop_id` | 店舗ID | 必須 | 接続確認対象の店舗のshop_id |

### 出力パラメータ

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


### 店舗マスタ

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗ID | `shop_id` | 数値型 | |
| 店舗名 | `shop_name` | 文字列型 | |
| 店舗名カナ | `shop_kana` | 文字列型 | |
| 店舗略名 | `shop_abbreviated_name` | 文字列型 | |
| 取扱商品名 | `shop_handling_goods_name` | 文字列型 | |
| 閉店日 | `shop_close_date` | 日時型 | |
| 備考 | `shop_note` | 文字列型 | |
| モールID | `shop_mall_id` | 数値型 | |
| オーソリ区分ID | `shop_authorization_type_id` | 文字列型 | |
| オーソリ区分名 | `shop_authorization_type_name` | 文字列型 | |
| 税区分ID | `shop_tax_id` | 文字列型 | |
| 税区分名 | `shop_tax_name` | 文字列型 | |
| 通貨単位区分ID | `shop_currency_unit_id` | 文字列型 | |
| 通貨単位区分名 | `shop_currency_unit_name` | 文字列型 | |
| 税計算順序 | `shop_tax_calculation_sequence_id` | 文字列型 | 0:商品計で税計算,1:単価から税計算 |
| 後払い.com サイトID | `shop_type_id` | 文字列型 | |
| 削除フラグ | `shop_deleted_flag` | 文字列型 | |
| 作成日 | `shop_creation_date` | 日時型 | |
| 最終更新日 | `shop_last_modified_date` | 日時型 | |
| 最終更新日 | `shop_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `shop_creator_id` | 数値型 | |
| 作成担当者名 | `shop_creator_name` | 文字列型 | |
| 最終更新者ID | `shop_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `shop_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `shop_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `shop_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


 サンプル
### サンプル

リクエスト

```bash
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
```

レスポンス

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


## エラー

### エラーコード

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

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `012001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `012002` | POSTパラメータにshop_idが指定されていない、または値が空です。 | shop_idを指定してください |
| `012003` | 店舗[_xxx_]は存在しません。 | shop_idを確認してください |
| `012004` | 店舗[_xxx_]は使用停止中の為、接続確認出来ません。 | メイン機能で店舗の使用を再開してください |
| `012005` | _xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_ | 接続失敗の理由を確認してください |

## 関連リンク

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

### 同じカテゴリの他のエンドポイント (店舗マスタ)

- [店舗マスタ件数取得](/api/api_v1_master_shop/count/) — `POST /api_v1_master_shop/count`
- [店舗マスタ店舗作成](/api/api_v1_master_shop/create/) — `POST /api_v1_master_shop/create`
- [店舗マスタ受注情報取り込み用メールアドレス取得](/api/api_v1_master_shop/mailaddress/) — `POST /api_v1_master_shop/mailaddress`
- [店舗マスタ検索](/api/api_v1_master_shop/search/) — `POST /api_v1_master_shop/search`
- [店舗マスタ店舗更新](/api/api_v1_master_shop/update/) — `POST /api_v1_master_shop/update`