ポンパレモールWEBサービス/商品検索API

説明

商品検索APIは、ポンパレモールに公開されている商品情報を検索する機能を提供します。

リクエストURL

http://itemsearch.api.ponparemall.com/1_0_0/search/

リクエストパラメーター

パラメーター 項目名 説明 必須
key APIキー APIを利用するためのキーです。
アカウント登録時に割り当てられるAPIキーを指定してください。
limit 取得件数 1-100までが指定可能
(デフォルト:60)
-
page ページ番号 1-100までが指定可能
(デフォルト:1)
-
format 返却形式 json / jsonp
(デフォルト:jsonp)
-
callback コールバック関数名 jsonpとして出力する際のコールバック関数名
(デフォルト:"callback")
-
keywordAnd ANDキーワード すべてのキーワードを含む-
keywordOr ORキーワード いずれかのキーワードを含む-
genreId ジャンルID ジャンルIDの一覧はこちら-
shopCtgryId ショップ内カテゴリID ※指定時はショップURL必須-
campaignId キャンペーンID -
shopUrl ショップURL [ショップURL]は商品ページのURLで確認できます。
「http://store.ponparemall.com/[ショップURL]/goods/[商品管理ID]/」
-
itemManageId 商品管理ID [商品管理ID]は商品ページのURLで確認できます。
「http://store.ponparemall.com/[ショップURL]/goods/[商品管理ID]/」
-
searchByItemNameFlg 商品名絞り込みフラグ 0:絞り込み無し、1:商品名で探す
(デフォルト:0)
-
minPrice 販売価格帯MIN 価格帯(下限)-
maxPrice 販売価格帯MAX 価格帯(上限)-
inStockFlg 在庫ありフラグ 0:絞り込み無し、1:在庫あり
(デフォルト:0)
-
incShippingFlg 送料無料フラグ 0:絞り込み無し、1:送料無料
(デフォルト:0)
-
over4pointFlg ポイント4%以上フラグ 0:絞り込み無し、1:ポイント4%以上
(デフォルト:0)
-
cardAvailableFlg カード有効フラグ 0:絞り込み無し、1:カードOK
(デフォルト:0)
-
deferredPymntAvailableFlg 後払い有効フラグ 0:絞り込み無し、1:後払いOK
(デフォルト:0)
-
carrAvailableFlg 携帯キャリア決済可能フラグ 0:絞り込み無し、1:携帯キャリア決済OK
(デフォルト:0)
-
carrDcAvailableFlg ドコモケータイ払い可能フラグ 0:絞り込み無し、1:ドコモケータイ払いOK
(デフォルト:0)
-
carrAuAvailableFlg auかんたん決済可能フラグ 0:絞り込み無し、1:auかんたん決済OK
(デフォルト:0)
-
carrSbAvailableFlg ソフトバンクまとめて支払い可能フラグ 0:絞り込み無し、1:ソフトバンクまとめて支払いOK
(デフォルト:0)
-
giftAvailableFlg ギフト対応可フラグ 0:絞り込み無し、1:ギフト対応可
(デフォルト:0)
-
codAvailableFlg 代金引換可フラグ 0:絞り込み無し、1:代金引換可
(デフォルト:0)
-
specifyDeliveryDateFlg 配送日指定フラグ 0:絞り込み無し、1:配送日指定可
(デフォルト:0)
-
nxdayDlvAvailableFlg 翌日お届け可フラグ 0:絞り込み無し、1:翌日お届け可
(デフォルト:0)
-
sortType 並び順 1:標準、2:価格の安い順、3:価格の高い順、4:新着順
(デフォルト:1)
-
searchMode モード 1:全部 2:コンパクト 3:ミニマム
(デフォルト:1)
-
imgMaxCount 商品画像枚数上限 デフォルト:3-
imgSize 商品画像サイズ 64,80,96,100,144,150,160,192,200,240,300,480,500
(デフォルト:150)
-
janCode JANコード -
facetResFlg ファセット返却フラグ デフォルト:0-

サンプルリクエストURL

※ keyの「**********」を取得したAPIキーに置き換えて実行してください。

レスポンスフィールド

     
Lv フィールド 項目名 備考 出現回数
1 count 検索結果数 1
1 first 商品開始番号 1
1 hits 返却件数 1
1 itemInfoList 商品情報リスト 1
2     itemName 商品名 N
2     itemUrl 商品URL N
2     itemId 商品ID N
2     itemManageId 商品管理ID N
2     itemImgInfoList 商品画像URLリスト N
3         itemImgUrl 商品画像URL N
3         sortOrder 商品画像URL並び順 N
2     salePriceIncTax 販売価格(税込み) 1
2     pointRate ポイント率 1
2     pointCount ポイント数 1
2     incShippingFlg 送料フラグ 1
2     shopName SEO店舗名 1
2     shopTopUrl ショップTOPURL 1
2     shopUrl ショップURL 1
2     shopId ショップID ※暗号化1
2     shopCtgryInfoList ショップ内カテゴリ N
3         shopCtgryId ショップ内カテゴリID N
3         shopCtgryUrl ショップカテゴリURL N
2     genreInfoList ジャンル情報リスト N
3         genreId ジャンルID N
3         genreName ジャンル名 N
2     cardAvailableFlg カード有効フラグ 1
2     deferredPymntAvailableFlg 後払い有効フラグ 1
2     carrAvailableFlg 携帯キャリア決済有効フラグ 1
2     carrDcAvailableFlg ドコモケータイ払い有効フラグ 1
2     carrAuAvailableFlg auかんたん決済有効フラグ 1
2     carrSbAvailableFlg ソフトバンクまとめて支払い有効フラグ 1
2     inStockFlg 在庫ありフラグ 1
2     saleStartTs 販売開始時間 ※未設定時は表示しない1
2     saleEndTs 販売終了時間 ※未設定時は表示しない1
2     reviewScore 商品レビュー平均点 1
2     reviewCount 商品レビュー件数 1
2     itemDescriptionText 商品説明テキスト ※未設定時は表示しない1
2     noshiFlg のしフラグ 1
2     giftAvailableFlg ギフト対応可フラグ 1
2     codAvailableFlg 代金引換可フラグ 1
2     nxdayDlvAvailableFlg 翌日お届け可フラグ 1
2     prchsStepDispFlg 配送日指定フラグ 1
2     dispPrice 表示価格 ※未設定時は表示しない1
2     taxKind 税別/税込/非課税 1
2     janCode JANコード ※未設定時は表示しない1
1 requestGenre 自ジャンル情報 1
2     genreName 自ジャンル名 1
2     genreId 自ジャンルID 1
2     genreUrl 自ジャンルURL 1
2     genreLevel 自ジャンル階層 1
2     genreOrder 同階層内ジャンル順位 1
2     count ヒット件数 1
1 childrenGenre 子階層ジャンルリスト 1
2     genreName ファセットジャンルID N
2     genreId ファセットジャンル名 N
2     genreUrl ファセットジャンルURL N
2     genreLevel ファセットジャンル階層 N
2     genreOrder 同階層内ジャンル順位 N
2     count ヒット件数 N
1 siblingsGenre 兄弟階層ジャンルリスト 1
2     genreName ファセットジャンルID N
2     genreId ファセットジャンル名 N
2     genreUrl ファセットジャンルURL N
2     genreLevel ファセットジャンル階層 N
2     genreOrder 同階層内ジャンル順位 N
2     count ヒット件数 N
1 parentsGenre 祖先階層ジャンルリスト 1
2     genreName ファセットジャンルID 1
2     genreId ファセットジャンル名 1
2     genreUrl ファセットジャンルURL 1
2     genreLevel ファセットジャンル階層 1
2     genreOrder 同階層内ジャンル順位 1
2     count ヒット件数 1
1 last 商品終了番号 1
1 page ページ番号 1
1 pageCount 総ページ数 1

エラー

ポンパレモールWEBサービスは共通のエラーを返します。
詳しくは、ガイドラインをご覧ください。