ショッピングサーチAPI仕様

【更新履歴】
2009/07/13

  • 出力項目に3キャリア共通リンクコードを追加しました。
  • 1. 検索方法

    下記URLへ必要なGETパラメータを付与しアクセスすることでXML情報を返却します。
    http://xml.accesstrade.net/at/ws.html

    2. 必須パラメータ

    パラメータ 備考
    ws_type searchgoods_atm APIタイプ、固定値です。
    ws_ver 1 バージョン、固定値です。
    ws_id ** 管理画面で取得したWS_ID

    3. 選択必須パラメータ

    ※何れか一つの指定が必須となります。
    パラメータ 備考
    item_id 70098-123456 商品ID、カンマ区切りで複数指定が可能です。
    category1 100 大カテゴリー、カンマ区切りで複数指定が可能です。
    カテゴリー一覧を参照してください。
    shop 112345 ショップID(マーチャントID)
    カンマ区切りで複数指定が可能です。
    search %e3%83%86%e3%83%ac
    %e3%83%93(テレビ)
    検索キーワード、UTF-8でエンコード

    4. 任意パラメータ

    パラメータ名 パラメータ 設定例 備考
    category2 中カテゴリー - ※現在未使用です
    category3 小カテゴリー - ※現在未使用です
    price_max 価格上限 150000 数値指定
    price_min 価格下限 800 数値指定
    row 1ページ内件数 5 1~30の範囲で指定可能、整数値指定
    page 指定ページ 2 2ページ目以降の明細を取得する際に指定、指定なしの場合は1ページが表示される。
    sort ソート 1 整数値指定 ソート一覧参照
    carrier キャリア 111 整数値指定。左桁より,docomo,au,softbank
    1:対応,0:非対応

    5. 出力項目

    パラメータ名 設定値 内容
    AllResult - 検索結果タグ
    Request - 入力パラメータの結果タグ
    ws_type searchgoods_atm サービスタイプ(固定値:必須)
    ws_ver 1 サービスバージョン(固定値:必須)
    ws_id 入力値 パートナーID(WS_ID:必須)
    item_id 入力値 一意なKEY
    category1 入力値 大カテゴリー(※カテゴリ一覧参照
    category2 入力値 中カテゴリー
    category3 入力値 小カテゴリー
    category4 入力値 極小カテゴリー
    shop 入力値 マーチャントID
    search 入力値 検索キーワード
    price_max 入力値 価格(上限)
    price_min 入力値 価格(下限)
    row 入力値 表示件数
    page 入力値 表示ページ
    sort 入力値 ソート
    TotalCount 検索結果の数
    TotalPage 検索結果の総ページ数
    CurrentCount 現在のページに含まれる検索数
    CurrentPage 現在のページ
    ErrorCode エラーコード
    ErrorMsg エラーメッセージ エラーがあればメッセージが表示される。
    Goods - 商品タグ
    ItemId 検索結果 商品ID(ユニークキー)
    Category1 検索結果 大カテゴリーID
    CategoryName1 検索結果 大カテゴリー名
    Category2 検索結果 中カテゴリーID
    CategoryName2 検索結果 中カテゴリー名
    Category3 検索結果 小カテゴリーID
    CategoryName3 検索結果 小カテゴリー名
    Category4 検索結果 極小カテゴリーID
    CategoryName4 検索結果 極小カテゴリー名
    GoodsName 検索結果 商品名
    GoodsCode 検索結果 商品コード
    JanCode 検索結果 JANコード
    Maker 検索結果 メーカー
    ImageUrl_1 検索結果 商品画像URL1
    Width_1 検索結果 横サイズ1
    Height_1 検索結果 縦サイズ1
    ImageUrl_2 検索結果 商品画像URL2
    Width_2 検索結果 横サイズ2
    Height_2 検索結果 縦サイズ2
    ImageUrl_3 検索結果 商品画像URL3
    Width_3 検索結果 横サイズ3
    Height_3 検索結果 縦サイズ3
    LinkCode 検索結果 3キャリア共通リンクコード(docomo,au,softbank対応)
    LinkCode_I 検索結果 リンクコード(i-mode)
    LinkCode_E 検索結果 リンクコード(ezweb)
    LinkCode_S 検索結果 リンクコード(softbank)
    Carrier_I 検索結果 i-mode対応状況(0:未対応 1:対応)
    Carrier_E 検索結果 ezweb対応状況(0:未対応 1:対応)
    Carrier_S 検索結果 softbank対応状況(0:未対応 1:対応)
    Price 検索結果 価格
    Postage 検索結果 送料
    CatchCopy 検索結果 キャッチコピー
    Stock 検索結果 在庫
    Explanation 検索結果 説明文
    RewardType 検索結果 報酬タイプ(0:クリック 1:定額 2:売上)
    RewardRate 検索結果 報酬率
    Reward 検索結果 報酬額
    Status 検索結果 提携状態(2:提携中)
    Shop 検索結果 マーチャントID
    ShopName 検索結果 マーチャント名
    Formal 検索結果 0:公式 1:非公式
    ShopDescription 検索結果 マーチャント概要
    • レスポンスデータには,未入力の項目もありますので事前に取得した結果を確認してください。

    6. 検索例

    ws_idは管理画面で取得されたws_idに置き換えてください。

    ■ カテゴリー:(100)家電・AVで、商品を探す。

    http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchgoods_atm&ws_id=****&category=100

    ■ カテゴリー:(100)家電・AVで、上限価格:¥13,000-で商品を探す。

    http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchgoods_atm&ws_id=****&category=100&price_max=13000

    ■ キーワード:液晶テレビで、商品を探す。

    http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchgoods_atm&ws_id=****&search=%e6%b6%b2%e6%99%b6%e3%83%86%e3%83%ac%e3%83%93

    ■ キーワード:液晶テレビで、商品ID:186182-J000027975,186182-J000027989で、商品を探す。

    http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchgoods_atm&ws_id=****&search=%e6%b6%b2%e6%99%b6%e3%83%86%e3%83%ac%e3%83%93&item_id=186182-J000027975,186182-J000027989


    カテゴリー一覧

    7. 大カテゴリー

    カテゴリーID カテゴリー名
    100 家電・AV
    200 パソコン・周辺機器
    300 CD・DVD・楽器
    400 スポーツ・アウトドア
    500 ダイエット・健康
    600 バッグ・小物・ブランド雑貨
    700 ファッション・アパレル
    800 キッチン・日用品雑貨
    900 食品
    1000 フラワー・ガーデニング
    1100 ドリンク・お酒
    1200 美容・コスメ・香水
    1300 ジュエリー・腕時計
    1400 インテリア
    1500 PCソフト
    1600 おもちゃ・ゲーム
    1700 コンタクトレンズ
    1800 自動車・バイク
    1900 書籍・雑誌
    2000 ダウンロード
    2100 グッズ・コレクション
    2200 ペット

    8. 中カテゴリー

    ※カテゴリ一覧参照

    9. 小カテゴリー

    ※カテゴリ一覧参照

    ソート一覧

    10. ソート条件

    ソート項目
    商品名(昇順) 1
    価格(昇順) 2
    価格(降順) 3
    報酬額(降順) 4
    大カテゴリーID(昇順) 5
    マーチャントID(昇順) 6
    ランダム検索 7


    TOPへ |  ATMWSサンプルの使用について |  API仕様 |  絵文字一覧 |  ダウンロード