Pococa API Ver 1.29 マニュアル

店舗API

URL:http://www.pococa.com/api/shop/

店舗検索

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 ShopSearch
offset 開始位置 条件に合う店舗の何番目から取得するかを指定します。 0から始まる整数値
count 取得件数 条件に合う店舗を開始位置から何店舗取得するかを指定します。 1から始まる整数値
shopcategory 店舗カテゴリー 店舗カテゴリーを絞り込みます。
※店舗カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの店舗カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。
areacategory 地域カテゴリー 地域カテゴリーを絞り込みます。
※地域カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの地域カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。
isshopcategoryrecursive 店舗カテゴリー再帰検索フラグ 指定された店舗カテゴリーの子孫に属する店舗まで再帰検索をするかどうかを指定します。 1:指定された店舗カテゴリー(shopcategory)以下すべての階層(子、孫など)の店舗を検索対象とします。
1以外:指定された店舗カテゴリー(shopcategory)に直接属する店舗のみを検索対象とします。
isareacategoryrecursive 地域カテゴリー再帰検索フラグ 指定された地域カテゴリーの子孫に属する地域まで再帰検索をするかどうかを指定します。 1:指定された地域カテゴリー(areacategory)以下すべての階層(子、孫など)の地域を検索対象とします。
1以外:指定された地域カテゴリー(areacategory)に直接属する地域のみを検索対象とします。
keyword 検索キーワード 検索するキーワードを指定します。 文字エンコードをUTF-8で指定して下さい。
※半角スペースで区切ることでAnd検索を行うことができます。
apikey APIキー文字列 APIキー文字列を指定します。(流通パートナーのみ必要なパラメータです。) 流通パートナー契約時にお知らせします。

レスポンス

フィールド 説明 出現回数
shoplist 店舗リスト 1
shopinfo 店舗情報 表示件数分
shopid 店舗ID 1 1
shopname 店舗名 1 Pococa!運営事務局
shopimageurl 店舗画像URL 1 http://www.pococa.com/system/shopimages/1-20060218-175225.jpg
address 住所 1 栃木県宇都宮市幸町9-17
telno 電話番号 1 028-625-8627
eigyoujikan 営業時間 1 平日:9:00〜18:00
teikyuubi 定休日 1 土日祝日
parking 駐車場 1 お客様専用駐車場 5台
shopurl 店舗URL 1 http://www.pococa.com/
shopkurl 店舗ケータイURL 1 http://pococa.com/
shopintro 店舗1行紹介文 1 Pococa!運営事務局です。
news お知らせ 1 店舗情報を公開しました。
latitude 緯度 1 36.554154454452465
longitude 経度 1 139.86596703529358
shopinfoupdate 更新日 1 20091020
openstart 公開日 1 20050517
iscouponshop クーポン発行店舗フラグ
(発行:true、未発行:false)
1 true
ismembercardshop 会員カード発行店舗フラグ
(発行:true、未発行:false)
1 true
cat_visibleshopstate 閲覧可能ステータス
(1:一般 2:ポコカ会員 3:店舗会員)
1 1

店舗数取得

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 ShopCount
shopcategory 店舗カテゴリー 店舗カテゴリーを絞り込みます。
※店舗カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの店舗カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。
areacategory 地域カテゴリー 地域カテゴリーを絞り込みます。
※地域カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの地域カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。
isshopcategoryrecursive 店舗カテゴリー再帰検索フラグ 指定された店舗カテゴリーの子孫に属する店舗まで再帰検索をするかどうかを指定します。 1:指定された店舗カテゴリー(shopcategory)以下すべての階層(子、孫など)の店舗を検索対象とします。
1以外:指定された店舗カテゴリー(shopcategory)に直接属する店舗のみを検索対象とします。
isareacategoryrecursive 地域カテゴリー再帰検索フラグ 指定された地域カテゴリーの子孫に属する地域まで再帰検索をするかどうかを指定します。 1:指定された地域カテゴリー(areacategory)以下すべての階層(子、孫など)の地域を検索対象とします。
1以外:指定された地域カテゴリー(areacategory)に直接属する地域のみを検索対象とします。
keyword 検索キーワード 検索するキーワードを指定します。 文字エンコードをUTF-8で指定して下さい。
※半角スペースで区切ることでAnd検索を行うことができます。

レスポンス

フィールド 説明 出現回数
shopcountinfo 店舗数情報 1
count 店舗数 1 1

店舗情報取得

リクエスト(sid任意:閲覧可能ステータスに対応するためには必要)

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 ShopInfo
shopid 店舗ID 取得する店舗の店舗IDを指定します。 1
apikey APIキー文字列 APIキー文字列を指定します。(流通パートナーのみ必要なパラメータです。) 流通パートナー契約時にお知らせします。

レスポンス

フィールド 説明 出現回数
shopinfo 店舗情報 1
shopid 店舗ID 1 1
shopname 店舗名 1 Pococa!運営事務局
shopimageurl 店舗画像URL 1 http://www.pococa.com/system/shopimages/1-20060218-175225.jpg
address 住所 1 栃木県宇都宮市幸町9-17
telno 電話番号 1 028-625-8627
eigyoujikan 営業時間 1 平日:9:00〜18:00
teikyuubi 定休日 1 土日祝日
parking 駐車場 1 お客様専用駐車場 5台
shopurl 店舗URL 1 http://www.pococa.com/
shopkurl 店舗ケータイURL 1 http://pococa.com/
shopemail 店舗Email 1 info@pococa.com
shopintro 店舗1行紹介文 1 Pococa!運営事務局です。
openstart 公開日 1 20050517
ownermessage 店長からのメッセージ 1 Pococa!の展示会にいらしてください!
recommend オススメ・ミドコロ 1 ポコカは、お店の集客とリピート化に対する新しい手法です。まずは、店舗登録を!
news お知らせ 1 来年の、ICワールドに出展します!是非、お越しください。
latitude 緯度 1 36.554154454452465
longitude 経度 1 139.86596703529358
shopcategoryid 店舗カテゴリID 1 11
shopcategoryname 店舗カテゴリ名 1 アミューズメント
iscouponshop クーポン発行店舗フラグ
(発行:true、未発行:false)
1 true
ismembercardshop 会員カード発行店舗フラグ
(発行:true、未発行:false)
1 true
cat_visibleshopstate 閲覧可能ステータス
(1:一般 2:ポコカ会員 3:店舗会員)
1 1
visibleshopstate 閲覧可能情報 1 一般ユーザーが閲覧可能です。
isvisibleshop

店舗情報取得結果ステータス
(可:true、不可:false)

1 true

店舗カテゴリ検索

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 ShopCategorySearch
searchtype 検索タイプ 検索タイプを指定します。 ParentSearch:指定カテゴリーからTopカテゴリーまで親カテゴリーを再帰的に検索します。(指定カテゴリーを含む)
ChildSearch:指定カテゴリーから末端のカテゴリーまで子カテゴリーを再帰的に検索します。(指定カテゴリーを含まない)
shopcategory 店舗カテゴリ 基準となる店舗カテゴリを指定します。
※店舗カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの店舗カテゴリー
areacategory 地域カテゴリー 基準となる地域カテゴリを指定します
※地域カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの地域カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。

レスポンス

フィールド 説明 出現回数
shopcategorylist 店舗カテゴリーリスト 1
shopcategoryinfo 店舗カテゴリー情報 表示件数分
shopcategoryid 店舗カテゴリーID 1 1
shopcategoryname 店舗カテゴリー名 1 グルメ
shopcount 店舗数 1 34

エリアカテゴリ検索

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 AreaCategorySearch
searchtype 検索タイプ 検索タイプを指定します。 ParentSearch:指定カテゴリーからTopカテゴリーまで親カテゴリーを再帰的に検索します。(指定カテゴリーを含む)
ChildSearch:指定カテゴリーから末端のカテゴリーまで子カテゴリーを再帰的に検索します。(指定カテゴリーを含まない)
areacategory 地域カテゴリー 基準となる地域カテゴリを指定します
※地域カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの地域カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。
shopcategory 店舗カテゴリ 基準となる店舗カテゴリを指定します。
※店舗カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの店舗カテゴリー

レスポンス

フィールド 説明 出現回数
areacategorylist エリアカテゴリーリスト 1
areacategoryinfo エリアカテゴリー情報 表示件数分
areacategoryid エリアカテゴリーID 1 1
areacategoryname エリアカテゴリー名 1 栃木県
shopcount 店舗数 1 34

店舗メニュー情報取得

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 ShopMenu
shopmenucategory 店舗メニューカテゴリ 店舗メニューカテゴリを指定します。 0

レスポンス

フィールド 説明 出現回数
shopmenulist 店舗メニューリスト 1
shopmenuinfo 店舗メニュー情報 表示件数分
shopmenuno 店舗メニューNO 1 1
shopmenuname 店舗メニュー名 1 シャンプー
shopmenuamnt 店舗メニュー料金 1 \525
shopmenuimageurl 店舗メニュー画像URL 1 http://www.pococa.com/system/shopmenuimages/1-menuimage-20090628-190637.jpg

店舗メニューカテゴリ検索

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 ShopMenuCategorySearch
searchtype 検索タイプ 検索タイプを指定します。 ParentSearch:指定カテゴリーからTopカテゴリーまで親カテゴリーを再帰的に検索します。(指定カテゴリーを含む)
ChildSearch:指定カテゴリーから末端のカテゴリーまで子カテゴリーを再帰的に検索します。(指定カテゴリーを含まない)
shopid 店舗ID 取得する店舗の店舗IDを指定します。 1
shopmenucategory 店舗カテゴリ 基準となる店舗メニューカテゴリを指定します。
0

レスポンス

フィールド 説明 出現回数
shopmenucategorylist 店舗メニューカテゴリーリスト 1
shopmenucategoryinfo 店舗メニューカテゴリー情報 表示件数分
shopmenucategoryid 店舗メニューカテゴリーID 1 1
shopmenucategoryno 店舗メニューカテゴリーNO 1 1
shopmenucategoryname 店舗メニューカテゴリー名 1 カット

Copyright(c) ZEAD Co.,Ltd. 2012, All rights reserved.