Wowma!API:商品情報の複数取得API

Wowma!API:商品情報の複数取得API

Wow!manager登録済商品の情報取得API(Ver.複数)

出品中商品の情報をまとめて取得するAPI。複数取得バージョンだけありインプット項目に部分一致検索してくれるものが多い。販売区分=選択肢販売だけ抽出なども可能なため利便性はとても高い。Ver.シングルの検索にロットナンバーが」必要な事もあり、Ver.複数でロットナンバーを取得DBに保存する動作は必須になる。

APIメソッド:searchItemInfos

指定した条件に合致する商品情報取得し、結果XML文字列を返却する。

REST API / HTTP Method

REST API HTTP Method
https://api.manager.wowma.jp/wmshopapi/searchItemInfos GET

Request

Header
No Key Value Note
1 Authorization Bearer “アプリケーションキー” 認証方式と”APIキー”を設定
2 Content-Type application/x-www-form-urlencoded
Body (INPUT)
No 分類 プロパティ名 Element 必須 byte 説明
1 共通 店舗ID shopId long 18 半角数字:18桁
各店舗様へ割り振られた会員番号
2 個別 最大取得件数 totalCount string 説明欄の値のみ
データの取得件数(最大値500)を指定
指定なし:デフォルト(10)
3 個別 取得開始件数 startCount string 半角数字:9桁
何件目からデータの取得をはじめるかを指定
(例:データが100件あった場合。
startを「26」にしてmax_resultを「25」にした場合は、
100件あるデータのうち26件目~50件目のデータを取得する。)
指定なし:デフォルト(1)
4 個別 販売ステータス saleStatus string 1 説明欄の値のみ
完全一致検索(フィルタ)
1:販売中商品
2:販売終了商品
5 個別 商品名 itemName string 128 全角:64桁
半角:128桁
部分一致
6 個別 管理用ID itemManagementId string 128 全角:64桁
半角:128桁
部分一致
7 個別 ロットナンバー lotNumber long 18 半角数字:18桁
完全一致検索
8 個別 商品コード itemCode string 256 全角:128桁
半角:256桁
店舗内の商品でユニークな項目、部分一致
9 個別 在庫区分 stockSegment string 1 説明欄の値のみ
完全一致検索(フィルタ)
1:通常在庫
2:選択肢別在庫
10 個別 出品在庫数下限 stockCountFrom string 5 半角数字:5桁
範囲検索
在庫区分で通常在庫が選択されている場合のみ指定可能
0~99999個
検索例:出品在庫数下限=0、出品在庫数上限=10とセットすることで通常在庫10個以下の商品を検索できます。
11 個別 出品在庫数上限 stockCountTo string 5 半角数字:5桁
範囲検索
在庫区分で通常在庫が選択されている場合のみ指定可能
0~99999個
検索例:出品在庫数下限=0、出品在庫数上限=10とセットすることで通常在庫10個以下の商品を検索できます。
12 個別 ポイント付与率下限 pointRateFrom string 2 半角数字:2桁
範囲検索
1~20倍を指定可能
13 個別 ポイント付与率上限 pointRateTo string 2 半角数字:2桁
範囲検索
1~20倍を指定可能
14 個別 送料設定区分 postageSegment string 1 説明欄の値のみ
完全一致検索(フィルタ)
1:送料別
2:送料込み
3:個別送料
15 個別 個別送料 postage string 19 半角数字:19桁
完全一致検索
[送料設定区分]が個別送料の時のみ設定する。
16 個別 (旧)配送方法ID deliveryId string 20 全角:10桁
半角:20桁
M(メール便)が指定された場合、メール便を利用する商品のみ検索する。
17 個別 (新)配送方法ID deliveryMethodId string 10 全角:5桁
半角:10桁
配送方法ID(店舗側で設定できる値) (例:TAKUHAI)
18 個別 カテゴリID categoryId string 20 全角:10桁
半角:20桁
完全一致検索
19 個別 タグ区分 tagSegment string 1 説明欄の値のみ
有無フィルタ
1:タグ設定なし
2:タグ設定あり
20 個別 パスワード制限設定 limitedPasswd string 1 説明欄の値のみ
有無フィルタ
1:パスワード制限設定なし
2:パスワード制限設定あり
21 個別 販売方法区分 sellMethodSegment string 1 説明欄の値のみ
1:通常販売
2:予約販売
22 個別 入荷リクエスト設定 stockRequestConfig string 1 説明欄の値のみ
有無フィルタ
1:入荷リクエスト設定なし
2:入荷リクエスト設定あり

Response

Header
No Key Value Note
1 Content-Type application/xml; charset=utf-8
Body (OUTPUT)
No 分類 プロパティ名 Element byte 説明 通常商品 選択肢商品
1 共通 レスポンス response group
2 共通 処理結果 response.result group
3 共通 処理結果コード response.result.status string 1 0:成功
1:失敗
4 共通 エラー情報 response.result.error group 異常時発生アラート
5 共通 エラーコード response.result.error.code string 7 メッセージ一覧のメッセージIDを参照。
異常時発生アラート
6 共通 エラーメッセージ response.result.error.message string 1000 メッセージ一覧の詳細メッセージを参照。
異常時発生アラート
7 個別 処理結果詳細 response.searchResult group
8 個別 取得全件数 response.searchResult.maxCount string 商品検索でヒットした件数を返却
9 個別 表示件数 response.searchResult.resultCount string データの取得件数を表示
取得件数(最大値500)
10 個別 表示開始件数 response.searchResult.startCount string 検索結果の何件目からデータの表示を開始しているかを表示
11 個別 結果商品情報 response.searchResult.resultItems group 検索結果でヒットした商品数分返却する。
12 個別 ロットナンバー response.searchResult.resultItems.lotNumber long 18
13 個別 商品名 response.searchResult.resultItems.itemName string 128
14 個別 管理用ID response.searchResult.resultItems.itemManagementId string 128
15 個別 管理用商品名 response.searchResult.resultItems.itemManagementName string 128
16 個別 商品コード response.searchResult.resultItems.itemCode string 256
17 個別 販売価格 response.searchResult.resultItems.itemPrice string 19
18 個別 販売方法区分 response.searchResult.resultItems.sellMethodSegment string 1 販売方法区分を返却する
1:通常販売
2:予約販売
19 個別 発売(入荷)予定日 response.searchResult.resultItems.releaseDate string 8 発売(入荷)予定日を返却する(yyyyMMdd)
20 個別 予約登録日 response.searchResult.resultItems.reserveRegstDate string 8 予約登録日を返却する(yyyyMMdd)
21 個別 税区分 response.searchResult.resultItems.taxSegment string 1 1:内税
2:税なし
22 個別 送料設定区分 response.searchResult.resultItems.postageSegment string 1 1:送料別
2:送料込み
3:個別送料
23 個別 個別送料 response.searchResult.resultItems.postage string 19 [送料設定区分]が個別送料の時のみ設定する。
24 個別 (旧)配送方法 response.searchResult.resultItems.deliverys group 配送方法を返却する。
25 個別 (旧)配送方法ID response.searchResult.resultItems.deliverys.deliveryId string 20 [配送方法]がメール便の時、”M”(メール便)をセットする
26 個別 (旧)配送方法順序 response.searchResult.resultItems.deliverys.deliverySeq string 1 [配送方法ID]にMを入力した場合、固定値”1″をセットする
27 個別 (新)配送方法 response.searchResult.resultItems.deliveryMethod group 配送方法(新)を指定する。
(最大5個)
28 個別 (新)配送方法ID response.searchResult.resultItems.deliveryMethod.deliveryMethodId string 10 配送方法ID(店舗側で設定できる値) (例:TAKUHAI)
29 個別 (新)配送方法順序 response.searchResult.resultItems.deliveryMethod.deliveryMethodSeq string 1 配送方法IDに紐づく順序(1-5の値)
30 個別 (新)配送方法名 response.searchResult.resultItems.deliveryMethod.deliveryMethodName string 20 配送方法IDに紐づく配送方法名
31 個別 掲載開始日時 response.searchResult.resultItems.publicStartDate string 10 日付フォーマット ”yyyyMMddhh”
32 個別 ギフト包装・ギフトメッセージ区分 response.searchResult.resultItems.giftPackingSegment string 1 1:不可
2:可
33 個別 のし区分 response.searchResult.resultItems.noshiSegment string 1 1:不可
2:可
34 個別 最大購入設定区分 response.searchResult.resultItems.limitedOrderSegment string 1 1:指定なし
2:指定あり
35 個別 最大購入個数 response.searchResult.resultItems.limitedOrderCount string 5 [最大購入設定区分]で「指定あり」が選択されている場合、返却する
36 個別 商品説明(共通) response.searchResult.resultItems.description string 1024 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。
37 個別 SP用商品説明 response.searchResult.resultItems.descriptionForSP string 10240 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。
38 個別 PC用商品説明 response.searchResult.resultItems.descriptionForPC string 10240 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。
39 個別 商品詳細タイトル response.searchResult.resultItems.detailTitle string 20
40 個別 商品詳細説明 response.searchResult.resultItems.detailDescription string 640 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。
41 個別 スペック response.searchResult.resultItems.specs group スペック情報
42 個別 スペックタイトル response.searchResult.resultItems.specs.specTitle string 16
43 個別 詳細スペック response.searchResult.resultItems.specs.detailSpecs group スペック項目と値を返却する。
(最大5個)
44 個別 スペック名 response.searchResult.resultItems.specs.detailSpecs.specName string 16
45 個別 スペック値 response.searchResult.resultItems.specs.detailSpecs.spec string 20
46 個別 スペック項目順序 response.searchResult.resultItems.specs.detailSpecs.specSeq string 1
47 個別 検索キーワード response.searchResult.resultItems.searchKeywords group 検索キーワードを返却する。
(最大3個)
48 個別 検索キーワード response.searchResult.resultItems.searchKeywords.searchKeyword string 20
49 個別 検索キーワード順序 response.searchResult.resultItems.searchKeywords.searchKeywordSeq string 1
50 個別 画像 response.searchResult.resultItems.images group 画像のURLと名称を返却する。
(最大10個)
51 個別 商品画像URL response.searchResult.resultItems.images.imageUrl string 128
255
52 個別 商品画像名 response.searchResult.resultItems.images.imageName string 16
53 個別 商品画像順序 response.searchResult.resultItems.images.imageSeq string 2
54 個別 カテゴリID response.searchResult.resultItems.categoryId string 20
55 個別 カテゴリ名称 response.searchResult.resultItems.ctgryName string 255
56 個別 検索タグ response.searchResult.resultItems.tags group タグを返却する。
(最大64個)
57 個別 検索タグID response.searchResult.resultItems.tags.tagId string 20
58 個別 店舗内カテゴリ response.searchResult.resultItems.shopCategory group 店舗内カテゴリを返却する。
(最大10個)
59 個別 店舗内カテゴリ名(フルパス) response.searchResult.resultItems.shopCategory.shopCategoryName string 487 区切り「:」でカテゴリ階層1~カテゴリ階層8を連結する
60 個別 店舗内カテゴリ表示順位 response.searchResult.resultItems.shopCategoryDispSeq string 9 半角数字:1~999,999,999
61 個別 JANコード response.searchResult.resultItems.jan string 13
62 個別 ISBNコード response.searchResult.resultItems.isbn string 13
63 個別 型番 response.searchResult.resultItems.itemModel string 200
64 個別 パスワード制限設定 response.searchResult.resultItems.limitedPasswd string 100
65 個別 パスワード制限ページタイトル response.searchResult.resultItems.limitedPasswdPageTitle string 200 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。
66 個別 パスワード制限ページメッセージ response.searchResult.resultItems.limitedPasswdPageMessage string 320 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。
67 個別 販売ステータス response.searchResult.resultItems.saleStatus string 1 1:販売中商品
2:販売終了商品
68 個別 購入オプション response.searchResult.resultItems.itemOptions group 購入オプションを返却する。
(最大20個)
69 個別 購入オプションタイトル response.searchResult.resultItems.itemOptions.itemOptionTitle string 256
70 個別 購入オプション選択肢 response.searchResult.resultItems.itemOptions.itemOption string 1962
71 個別 購入オプション順序 response.searchResult.resultItems.itemOptions.itemOptionSeq string 1
72 個別 購入オプション(手数料型) response.searchResult.resultItems.itemOptionCommissions group 購入オプション(手数料型)を返却する。(最大20個)
73 個別 購入オプション(手数料型)タイトル response.searchResult.resultItems.itemOptionCommissions.itemOptionCommissionTitle string 256
74 個別 購入オプション(手数料型)値 response.searchResult.resultItems.itemOptionCommissions.itemOptionCommissionVal group 購入オプション(手数料型)の選択肢・価格を返却する。(最大10個)
75 個別 購入オプション(手数料型)選択肢 response.searchResult.resultItems.itemOptionCommissions.itemOptionCommissionVal.itemOptionCommission string 200
76 個別 購入オプション(手数料型)価格 response.searchResult.resultItems.itemOptionCommissions.itemOptionCommissionVal.itemOptionCommissionPrice string 13
77 個別 購入オプション(手数料型)選択肢・価格順序 response.searchResult.resultItems.itemOptionCommissions.itemOptionCommissionVal.itemOptionCommissionValSeq string 2
78 個別 購入オプション(手数料型)注意事項 response.searchResult.resultItems.itemOptionCommissions.itemOptionCommissionNote string 2000
79 個別 購入オプション(手数料型)順序 response.searchResult.resultItems.itemOptionCommissions.itemOptionCommissionSeq string 2
80 個別 ポイント倍率 response.searchResult.resultItems.pointRate string 2 1~20倍を指定可能
81 個別 お気に入り数 response.searchResult.resultItems.favoriteCount string 19
82 個別 (旧)入荷リクエスト数 response.searchResult.resultItems.receiptRequestCount string 19
83 個別 入荷リクエスト設定 response.searchResult.resultItems.stockRequestConfig string 1 1:受け付ける
2:受け付けない
取得した値がNULL場合、「1:受け付ける」を設置
84 個別 (新)入荷リクエスト数 response.searchResult.resultItems.stockRequestCount string 19
85 個別 登録在庫 response.searchResult.resultItems.registerStock group 通常在庫または選択肢別在庫の登録情報を返却する。
86 個別 在庫区分 response.searchResult.resultItems.registerStock.stockSegment string 1 1:通常在庫
2:選択肢別在庫
87 個別 通常在庫数 response.searchResult.resultItems.registerStock.stockCount string 19 在庫区分で通常在庫が選択されている場合、在庫数を設定する。
在庫区分で選択肢別在庫が選択されている場合、”選択肢別”と設定する。
88 個別 通常在庫発送日ID response.searchResult.resultItems.registerStock.stockShippingDayId string 10 文字列(登録している発送日ID(店舗側で設定できる値)を指定する。英数字、ハイフン、アンダースコアのみ可。半角10文字以内。)
89 個別 通常在庫発送日表示文言 response.searchResult.resultItems.registerStock.stockShippingDayDispTxt string 40 全半角20文字以内
90 個別 残在庫表示区分 response.searchResult.resultItems.registerStock.displayStockSegment string 1 1:在庫数を表示しない。
2:在庫数を表示する。
3:指定した在庫数以下の場合表示する。
91 個別 在庫表示閾値 response.searchResult.resultItems.registerStock.displayStockThreshold string 5 [残在庫表示区分]が「指定した在庫数以下の場合表示する。」が
選択されている場合、返却する
92 個別 選択肢別在庫横軸項目名 response.searchResult.resultItems.registerStock.choicesStockHorizontalItemName string 50
93 個別 選択肢別在庫横軸 response.searchResult.resultItems.registerStock.choicesStockHorizontals group 選択肢別在庫の横軸設定
(最大20個)
94 個別 選択肢別在庫横軸コード response.searchResult.resultItems.registerStock.choicesStockHorizontals.choicesStockHorizontalCode string 255
95 個別 選択肢別在庫横軸名 response.searchResult.resultItems.registerStock.choicesStockHorizontals.choicesStockHorizontalName string 100
96 個別 選択肢別在庫横軸順序 response.searchResult.resultItems.registerStock.choicesStockHorizontals.choicesStockHorizontalSeq string 2
97 個別 選択肢別在庫縦軸項目名 response.searchResult.resultItems.registerStock.choicesStockVerticalItemName string 50
98 個別 選択肢別在庫縦軸 response.searchResult.resultItems.registerStock.choicesStockVerticals group 選択肢別在庫の縦軸設定
(最大40個)
99 個別 選択肢別在庫縦軸コード response.searchResult.resultItems.registerStock.choicesStockVerticals.choicesStockVerticalCode string 255
100 個別 選択肢別在庫縦軸名 response.searchResult.resultItems.registerStock.choicesStockVerticals.choicesStockVerticalName string 100
101 個別 選択肢別在庫縦軸順序 response.searchResult.resultItems.registerStock.choicesStockVerticals.choicesStockVerticalSeq string 2
102 個別 選択肢別在庫 response.searchResult.resultItems.registerStock.choicesStocks group 選択肢別在庫の在庫数の設定
(最大20×40=800個)
103 個別 選択肢別在庫横軸コード response.searchResult.resultItems.registerStock.choicesStocks.choicesStockHorizontalCode string 255
104 個別 選択肢別在庫縦軸コード response.searchResult.resultItems.registerStock.choicesStocks.choicesStockVerticalCode string 255
105 個別 選択肢別在庫数 response.searchResult.resultItems.registerStock.choicesStocks.choicesStockCount string 6
106 個別 選択肢別在庫発送日ID response.searchResult.resultItems.registerStock.choicesStocks.choicesStockShippingDayId string 10 文字列(登録している発送日ID(店舗側で設定できる値)を指定する。英数字、ハイフン、アンダースコアのみ可。半角10文字以内。)
107 個別 選択肢別在庫発送日表示文言 response.searchResult.resultItems.registerStock.choicesStocks.choicesStockShippingDayDispTxt string 40 全半角20文字以内
108 個別 選択肢別在庫上説明 response.searchResult.resultItems.registerStock.choicesStockUpperDescription string 250 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。
109 個別 選択肢別在庫下説明 response.searchResult.resultItems.registerStock.choicesStockLowerDescription string 250 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。
110 個別 残選択肢別在庫表示区分 response.searchResult.resultItems.registerStock.displayChoicesStockSegment string 1 1:在庫数を表示しない。
2:在庫数を表示する。
3:指定した在庫数以下の場合、「△」を表示。
111 個別 選択肢別在庫表示閾値 response.searchResult.resultItems.registerStock.displayChoicesStockThreshold string 5 [残在庫表示区分]が「指定した在庫数以下の場合表示する。」が
選択されている場合、返却する
112 個別 在庫切れメッセージ response.searchResult.resultItems.registerStock.displayBackorderMessage string 64