Pococa API Ver 1.29 マニュアル

クーポンAPI

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

クーポン検索

リクエスト

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

レスポンス

フィールド 説明 出現回数 例
couponlist クーポンリスト 1
couponinfo クーポン情報 表示件数分
shopid 店舗ID 1 1
shopname 店舗名 1 Pococa!運営事務局
couponid クーポンID 1 63
intro クーポン1行紹介文 1 ポコカ運営会社　社名変更記念クーポン
naiyou クーポン内容 1 ポコカオリジナルケータイストラップをプレゼントいたします。
usestart 有効期間開始年月日 1 20101001
usestarttime 有効期間開始時分秒 １ 9:00
useend 有効期間終了年月日 1 20101231
useendtime 有効期間終了時分秒 １ 12:00
openstart 公開期間開始年月日 １ 2010901
openstarttime 公開期間開始時分秒 １ 0:00
openend 公開期間終了年月日 １ 2010930
openendtime 公開期間終了時分秒 １ 24:00
fixedprice 通常価格 (0:未設定) １ 5000
sellingprice 販売価格 (0:未設定) １ 1000
discountprice 割引額 (0:未設定) １ 4000
discountrate 割引率 (0:未設定) １ 80
usecondition クーポン利用条件 1 本クーポンを取得し、ポコカ運営事務局（ZEAD社内）までお越しくださいました方
uselimit クーポン利用回数上限
(0:上限なし,0以外:一人当たりのこのクーポンの利用回数が指定した値となります。)		 1 0
usecount クーポン利用済回数 1 1
sentyaku 先着人数
(0:上限なし,0以外:このクーポンの利用可能な回数が指定した値となります。)		 1 10
maxcouponcount 最大クーポン取得数 1 100
mincouponcount 最低クーポン取得数 1 10
point ポイント
(このクーポンを使用するともらえるポイント)		 1 10
coupondownloadcount クーポンのダウンロード数 1 5
couponimageurl クーポン画像URL 1

http://www.pococa.com/system/couponimages/1-couponimage-20090628-190637.jpg
coupondownloadurl クーポンダウンロード用URL 1
http://www.pococa.com/i/do/pccstcoupon?guid=ON&seq_m_coupon=1
qrcodeurl QRコード用URL 1
http://www.pococa.com/sys/do/qrcode?seq_m_coupon=1
state クーポン状態 1 ok

クーポン数取得

リクエスト

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

レスポンス

フィールド 説明 出現回数 例
couponcountinfo クーポン数情報 1
count クーポン数 1 1

クーポン情報取得

リクエスト

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

レスポンス

フィールド 説明 出現回数 例
couponinfo クーポン情報 表示件数分
shopid 店舗ID 1 1
shopname 店舗名 1 Pococa!運営事務局
shopimageurl 店舗画像URL 1 http://www.pococa.com/system/shopimages/1-20060218-175225.jpg
couponid クーポンID 1 63
intro クーポン1行紹介文 1 ポコカ運営会社　社名変更記念クーポン
naiyou クーポン内容 1 ポコカオリジナルケータイストラップをプレゼントいたします。
usestart 有効期間開始年月日 1 20061001
usestarttime 有効期間開始時分秒 １ 9:00
useend 有効期間終了年月日 1 20071231
useendtime 有効期間終了時分秒 １ 12:00
openstart 公開期間開始年月日 １ 2010901
openstarttime 公開期間開始時分秒 １ 0:00
openend 公開期間終了年月日 １ 2010930
openendtime 公開期間終了時分秒 １ 24:00
fixedprice 通常価格 (0:未設定) １ 5000
sellingprice 販売価格 (0:未設定) １ 1000
discountprice 割引額 (0:未設定) １ 4000
discountrate 割引率 (0:未設定) １ 80
usecondition クーポン利用条件 1 本クーポンを取得し、ポコカ運営事務局（ZEAD社内）までお越しくださいました方
uselimit クーポン利用回数上限
(0:上限なし,0以外:一人当たりのこのクーポンの利用回数が指定した値となります。)		 1
usecount クーポン利用済回数 1 1
sentyaku 先着人数
(0:上限なし,0以外:このクーポンの利用可能な回数が指定した値となります。)		 1 10
maxcouponcount 最大クーポン取得数 1 100
mincouponcount 最低クーポン取得数 1 10
point ポイント
(このクーポンを使用するともらえるポイント)		 1 10
coupondownloadcount クーポンのダウンロード数 1 5
couponimageurl クーポン画像URL 1

http://www.pococa.com/system/couponimages/1-couponimage-20090628-190637.jpg
coupondownloadurl クーポンダウンロード用URL 1
http://www.pococa.com/i/do/pccstcoupon?guid=ON&seq_m_coupon=1
qrcodeurl QRコード用URL 1
http://www.pococa.com/sys/do/qrcode?seq_m_coupon=1

クーポンカテゴリ検索

リクエスト

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

レスポンス

フィールド 説明 出現回数 例
couponcategorylist クーポンカテゴリーリスト 1
couponcategoryinfo クーポンカテゴリー情報 表示件数分
couponcategoryid クーポンカテゴリーID 1 1
couponcategoryname クーポンカテゴリー名 1 グルメ
couponcount クーポン数 1 34

クーポン属性取得

リクエスト

パラメータ 項目名 説明 値
operation オペレーションコード APIに行わせる操作の種類を指定します。 CouponAttr

レスポンス

フィールド 説明 出現回数 例
couponattrlist クーポン属性リスト 1
couponattrinfo クーポン属性情報 表示件数分
couponattrid クーポン属性ID 1 1
couponattrname クーポン属性名 1 食べ放題･飲み放題クーポン
couponcount クーポン数 1 5

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