利用可能店舗一覧API

概要

利用可能店舗の一覧を取得します。

URL

/cmapi/v2/providers/

メソッド

GET

リクエスト

リクエストパラメータ

パラメータ	必須	デフォルト	最大	説明	詳細	備考
page_size	-	20	100	ページ毎の件数	-	-
page	-	1	-	ページ数	-	-
sort	-	-id	-	ソート	指定された項目でソートを行う。降順でソートしたい場合、項目名の前に "-" を付与する。	現在、"id" の昇順降順のみ対応
is_deleted	-	-	-	削除済み店舗を取得するか		"true"を指定した時のみ削除済み店舗を取得

リクエストボディ

なし

リクエストのサンプル

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

レスポンス

メディアタイプ

application/json

レスポンスヘッダ

キー	説明	備考
X-Total-Count	総数
Link	リンク情報	次の形式で「次のページ」と「前のページ」の情報を付与。 `<next_page_url>; rel="next", <previous_page_url>; rel="previous"`

成功時レスポンス

「基底オブジェクト」のリストを返却

基底オブジェクト

キー	型	説明	詳細	備考
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"
  },
  {
    "id": 2,
    "uuid": "d6c1a054-0622-4054-b246-a6f37c559345",
    "name": "利用可能店舗 2",
    "additional_items": {
      "hours": "8:30 ~ 19:00",
      "phone": "03-xxx-xxxx",
      "address": "東京都大田区 xxxxx yyyy 2-15",
     "holiday": "",
      "shortName": "店舗 2",
      "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"
  }
]