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