実店舗登録API

指定した実店舗を登録します。

まずはじめに、「概要」「共通仕様」について、futureshop APIv2についてをご覧ください。

基本仕様

1店舗ずつ、実店舗情報を登録できます。

＜目次＞

更新/更新予定

※日付が「予定日」のものは、更新内容が変わる可能性がございます。

更新日/予定日	更新内容		更新理由
2022.02.24	リクエストボディ(json)	「必須」指定解除「storeNameLinkUrl」「storeNameFull」「zipCode」「address」「addressLinkUrl」「additionalItem11～5（name・url）」「htmlComment」「saleStoreCode」「stockStoreCode」	店舗受取オプション対応のため
2022.02.24	リクエストボディ(json)	「htmlComment」型・byte/文字制限変更	店舗受取オプション対応のため	参照
2022.02.24	リクエストボディ(json)	key新規追加「telNo」「telNoLinkEnabled」「storePickupEnabled」「storePickupGoogleTag」「storePickupComment」「storePickupDetailComment」「storePickupMail」	店舗受取オプション対応のため	参照
2022.02.24	エラーコード	新規追加されたkeyに対するエラーコードを新規追加「InvalidValue」「TooLong」「StorePickupAddressRequired」「StorePickupAddressInvalidValue」	店舗受取オプション対応のため	参照

更新履歴はAPI更新履歴一覧をご覧ください。

URL

https://{APIドメイン}/admin-api/v1/realstore

HTTPメソッド

POST

リクエストヘッダー

アクセストークンなどの詳細はアクセストークンによる認証を参照してください。

リクエストボディ(json)

key		項目名	必須	型	byte	内容
storeCode		店舗コード	◯	String	10
storeName		店舗名	◯	String	200
storeNameLinkUrl		店舗名(リンクURL)		String	200
storeNameFull		店舗名(正式名称)		String	200
displayOrder		表示順	◯	String	3
areaCode		店舗エリア	◯	String	8	北海道：HOKKAIDO 東北：TOHOKU 関東：KANTO 中部：CHUBU 関西：KANSAI 中国：CHUGOKU 四国：SHIKOKU 九州：KYUSHU 沖縄：OKINAWA その他：OTHER
zipCode		郵便番号		String	8
address		所在地		String	300
addressLinkUrl		所在地(リンクURL)		String	200
additionalItem1		任意項目1		-	-
	name	名称		String	100
	url	リンクURL		String	200
additionalItem2		任意項目2		-	-
	name	名称		String	100
	url	リンクURL		String	200
additionalItem3		任意項目3		-	-
	name	名称		String	100
	url	リンクURL		String	200
additionalItem4		任意項目4		-	-
	name	名称		String	100
	url	リンクURL		String	200
additionalItem5		任意項目5		-	-
	name	名称		String	100
	url	リンクURL		String	200
htmlComment		フリーコメントエリア		Text		最大16,000文字
saleStoreCode		販売店舗コード(omni)		String	10
stockStoreCode		在庫店舗コード		String	10
telNo		電話番号		String	13
telNoLinkEnabled		電話番号リンク利用設定		Boolean	-	true：リンク表示false：リンク非表示
storePickupEnabled		店舗受取利用設定		Boolean	-	true：店舗受取可false：店舗受取不可
storePickupGoogleTag		Googleマップ埋め込みタグ		Text	-	最大16,000文字
storePickupComment		フリーコメント		Text	-	最大16,000文字
storePickupDetailComment		受取店舗詳細フリーコメント		Text	-	最大16,000文字
storePickupMail		受取通知メールに挿入する文章		Text	-	最大1,000文字

サンプル（リクエストボディ）

{
    "storeCode": "STORE01",
    "storeName": "店舗1",
    "storeNameLinkUrl": "https://store01.jp",
    "storeNameFull": "実店舗第1店舗",
    "displayOrder": “1”,
    "areaCode": "KANSAI",
    "zipCode": "111-1111",
    "address": "大阪府大阪市A区B町1-1",
    "addressLinkUrl": "https://store01.jp",
    "additionalItem1": {
        "name": "任意項目1個目",
        "url": "https://additional01.jp",
    },
    "additionalItem2": {
        "name": "任意項目2個目",
        "url": "https://additional02.jp",
    },
    "additionalItem3": {
        "name": "任意項目3個目",
        "url": "https://additional03.jp",
    },
    "additionalItem4": {
        "name": "任意項目4個目",
        "url": "https://additional04.jp",
    },
    "additionalItem5": {
        "name": "任意項目5個目",
        "url": "https://additional05.jp",
    },
    "htmlComment": "テスト用の実店舗データ",
    "saleStoreCode": "SALESTORE01",
    "stockStoreCode": "STORESTOCK01"
}

レスポンス

key		項目名	必須	型	byte	内容
status		ステータス	○	String	-	成功：success 失敗：failed
errors		エラーリスト		Array	-	リクエストのエラー発生時に出力
	code	コード	○	String	-
	path	パス		String	-	入力値エラーの場合、対象のjson位置を出力
	message	メッセージ	○	String	-	エラーの概要が出力されます。

エラーコード

errors

コード	メッセージ	説明
WrongFormat	リクエストデータがjson形式ではありません	json形式ではない場合に返却されます。
Required	storeCodeを指定してください	storeCodeを正しく指定していない場合に返却されます。
InvalidValue	storeCodeの指定が不正です	英数が正しく指定されてない場合に返却されます。
TooLong	storeCodeは10文字以内で指定してください	storeCodeが長過ぎます。 10文字以内で指定して下さい。
Required	storeNameを指定してください	storeNameを正しく指定していない場合に返却されます。
TooLong	storeNameは100文字以内で指定してください	storeNameが長過ぎます。 100文字以内で指定して下さい。
InvalidValue	storeNameの指定が不正です	HTMLタグが存在する場合に返却されます。
Required	displayOrderを指定してください	displayOrderを正しく指定していない場合に返却されます。
InvalidValue	displayOrderの指定が不正です	数が正しく指定されてない場合に返却されます。
TooLong	storeNameLinkUrlは200文字以内で指定してください	storeNameLinkUrlが長過ぎます。 200文字以内で指定して下さい。
TooLong	storeNameFullは200文字以内で指定してください	storeNameFullが長過ぎます。 200文字以内で指定して下さい。
InvalidValue	storeNameFullの指定が不正です	HTMLタグが存在する場合に返却されます。
Required	areaCodeを指定してください	areaCodeを正しく指定していない場合に返却されます。
InvalidValue	areaCodeの指定が不正です	areaCodeの値が正しく指定していない場合に返却されます。
InvalidValue	zipCodeの指定が不正です	数が正しく指定されてない場合に返却されます。
TooLong	addressは150文字以内で指定してください	addressが長過ぎます。 150文字以内で指定して下さい。
TooLong	addressLinkUrlは200文字以内で指定してください	addressLinkUrlが長過ぎます。 200文字以内で指定して下さい。
TooLong	additionalItemList.nameは50文字以内で指定してください	additionalItemList.nameが長過ぎます。 50文字以内で指定して下さい。
TooLong	additionalItemList.urlは200文字以内で指定してください	additionalItemList.urlが長過ぎます。 200文字以内で指定して下さい。
TooLong	htmlCommentは8000文字以内で指定してください	htmlCommentが長過ぎます。 8000文字以内で指定して下さい。
InvalidHtmlTag	htmlCommentのHTMLタグが不正です	HTMLタグに不備がある場合に返却されます。
InvalidValue	saleStoreCodeの指定が不正です	saleStoreCodeを正しく指定していない場合に返却されます。
TooLong	saleStoreCodeは10文字以内で指定してください	saleStoreCodeが長過ぎます。 10文字以内で指定して下さい。
InvalidValue	stockStoreCodeの指定が不正です	stockStoreCodeを正しく指定していない場合に返却されます。
TooLong	stockStoreCodeは10文字以内で指定してください	stockStoreCodeが長過ぎます。 10文字以内で指定して下さい。
DuplicateStoreCode	storeCodeが重複しています	登録時に同じstoreCodeが存在する場合に返却されます。
DuplicateSaleStoreCode	saleStoreCodeが重複しています	登録時に同じsaleStoreCodeが存在する場合に返却されます。
DuplicateStockStoreCode	stockStoreCodeが重複しています	登録時に同じstockStoreCodeが存在する場合に返却されます。
InvalidValue	telNoの指定が不正です	電話番号の整合性チェックでエラーとなった場合に返却されます。
InvalidValue	telNoLinkEnabledの指定が不正です	TRUE、FALSE以外の値を指定をした場合に返却されます。
InvalidValue	storePickupEnabledの指定が不正です	TRUE、FALSE以外の値を指定をした場合に返却されます。
TooLong	storePickupCommentは16,000文字以内で指定してください	storePickupCommentが長過ぎます。 16,000文字以内で指定して下さい。
TooLong	storePickupMailは1,000文字以内で指定してください	storePickupMailが長過ぎます。 1,000文字以内で指定して下さい。
TooLong	storePickupGoogleTagは16,000文字以内で指定してください	storePickupGoogleTagが長過ぎます。 16,000文字以内で指定して下さい。
TooLong	storePickupDetailCommentは16,000文字以内で指定してください	storePickupDetailCommentが長過ぎます。 16,000文字以内で指定して下さい。
StorePickupAddressRequired	storePickupEnabledがTRUEの場合、addressは必須となります	storePickupEnabledにTRUEを指定し、addressを指定していない場合に返却されます。
StorePickupAddressInvalidValue	storePickupEnabledがTRUEの場合、addressは都道府県から始まる値を指定してください	storePickupEnabledにTRUEを指定し、addressに各都道府県から始まる値を指定していない場合に返却されます。

サンプル

サンプル（エラー時）

{
    "status": "failed",
    "errors": [
        {
            "code": "Invalid",
            "path": "storeCode",
            "message": "storeCodeの指定が不正です"
        }
    ]
}

サンプル（成功時）

{
    "status": "success"
}