実店舗取得API

指定した実店舗の情報を取得します。

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


<目次>

更新/更新予定

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

更新日/予定日 更新内容 更新理由
2022.02.24 レスポンス key新規追加
telNo/telNoLinkEnabled/storePickupEnabled/
storePickupGoogleTag/storePickupComment/
storePickupDetailComment/storePickupMail
店舗受取オプション対応のため 参照
2022.02.24 レスポンス 型変更 「htmlComment」String → text 参照

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

URL

URLにstoreCode(店舗コード)を指定してリクエストを行って下さい。

https://{APIドメイン}/admin-api/v1/realstore/{storeCode(店舗コード)}

HTTPメソッド

GET

リクエストヘッダー

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

リクエストボディ

なし

パラメータ

なし

レスポンス

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 -
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 内容
stauts ステータス String -
errors エラーリスト Array -
code コード String -
message メッセージ String -
エラーコード
コード メッセージ 説明
NotFound リソースが存在しません 指定の実店舗が存在しない場合に返却されます。

サンプル

{
    "status": "failed",
    "errors": [
        {
            "code": "NotFound",
            "message": "リソースが存在しません"
        }
    ]
}