コンテンツにスキップ

利用可能店舗詳細参照API

概要

指定したidの利用可能店舗情報を取得します。

URL

/cmapi/v2/providers/${provider_uuid}/

メソッド

GET

リクエスト

リクエストパラメータ

なし

リクエストボディ

なし

リクエストのサンプル

curl \
    -X GET \
    -H "X-POPINFO-MAPI-TOKEN: ${AUTH_TOKEN}" \
    https://${domain}/cmapi/v2/providers/${provider_uuid}/

レスポンス

メディアタイプ

application/json

成功時レスポンス

基底オブジェクト

キー 説明 詳細 備考
id 数値 ID - -
uuid 文字列 利用可能店舗 UUID - -
name 文字列 利用可能店舗名 - -
additional_items オブジェクト 任意追加項目 「レスポンス "additional_items" オブジェクト」を参照。 -
latitude 文字列 緯度 - -
longitude 文字列 経度 - -
created_at 文字列 作成日時 「yyyy-mm-dd hh:MM:ss」の形式 -
updated_at 文字列 更新日時 「yyyy-mm-dd hh:MM:ss」の形式 -

レスポンス "additional_items" オブジェクト

  • ユーザ独自の項目が登録されていた場合、FANSHIP システム公式の 6 項目の他に、ユーザ独自の項目も含めて返す。
キー 説明 詳細 備考
hours 文字列 営業時間 - -
phone 文字列 電話番号 - -
address 文字列 住所 - -
holiday 文字列 定休日 - -
shortName 文字列 店舗名略称 - -
thumbnail 文字列 サムネイル サムネイル画像データのフルパス(https:// ... ) 画像指定に関する仕様については「画像登録」シートを参照。

レスポンスのサンプル

{
    "id": 1,
    "uuid": "d516ca04-2062-4405-b246-a63f93457c55",
    "name": "利用可能店舗 1",
    "additional_items": {
        "hours": "AM 10:00 ~ PM 9:00",
        "phone": "03-xxx-xxxx",
        "address": "東京都港区 xxxxx yyyy 1-1",
        "holiday": "不定休",
        "shortName": "店舗 1",
        "thumbnail": "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"
    },
    "latitude": "35.662976",
    "longitude": "139.745087",
    "created_at": "2019-04-31 09:11:59",
    "updated_at": "2019-04-31 09:11:59"
}