店舗マスタ店舗作成
リクエストURL
Section titled “リクエストURL”ホスト
https://api.next-engine.org
エンドポイント
/api_v1_master_shop/create
リファレンス内容
Section titled “リファレンス内容”入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります
動作はメイン機能の店舗追加と同じです
【注意】メイン機能は50店舗まで作成可能ですが、一度登録した店舗は削除出来ません。開発時はチェックのみ実施するtest_flagを1にしてご利用下さい。店舗数が50になってしまった場合はこちらを確認下さい
入力パラメータ
Section titled “入力パラメータ”| パラメータ | 値 | 省略 | 備考 |
|---|---|---|---|
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 | 必須 | 詳細はこちらを参照 |
出力パラメータ
Section titled “出力パラメータ”| パラメータ名 | 値 | 備考 |
|---|---|---|
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 |
入力パラメータのdataで指定する値です サンプルはこちらを参照
| 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 |
|---|---|---|---|---|---|
| 1 | ○ | ||||
| 2 | ○ | 店舗情報の親タグ | |||
| 3 | ○ | 作成する店舗のフィールド名と値を指定します必須ではないフィールドは、タグ自体を省略することも可能です(値が空欄の場合と同じ挙動になります) | |||
| 2 | ○ | ||||
| 1 | ○ |
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/パスワードの扱い
Section titled “ログイン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 | 卸 | 利用しません |
店舗数が最大になってしまった場合
Section titled “店舗数が最大になってしまった場合”開発環境：リカバリすることは出来ませんが、[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の場合作成者名 |
サンプル
リクエスト
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レスポンス
{ "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"}エラーコード
Section titled “エラーコード”エンドポイント固有のエラーコードを以下に示します。 共通エラーコードは メッセージコード一覧 を参照してください。
| エラーコード | メッセージ | 対処方法 |
|---|---|---|
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 3.1 のインタラクティブ仕様) - エラーコード一覧:
/guides/param/message/(result/code/messageの意味) - フィールド一覧:
/guides/fields/master_shop/(このエンドポイントが扱うデータ項目)
同じカテゴリの他のエンドポイント (店舗マスタ)
Section titled “同じカテゴリの他のエンドポイント (店舗マスタ)”- 店舗マスタ店舗接続確認 —
POST /api_v1_master_shop/checkconnect - 店舗マスタ件数取得 —
POST /api_v1_master_shop/count - 店舗マスタ受注情報取り込み用メールアドレス取得 —
POST /api_v1_master_shop/mailaddress - 店舗マスタ検索 —
POST /api_v1_master_shop/search - 店舗マスタ店舗更新 —
POST /api_v1_master_shop/update