Wowma!API:商品情報更新API(Ver.シングル)

目次
Wow!managerの商品情報を細かく更新できるAPI
出品中の商品情報を個別に更新するAPI。検索キーワードや商品名などSEO的に変えたいパートはもちろん、商品サイズなどスペックに関する更新項目も更新可能なため、常用としてはこちらを利用する事になると思う。
APIメソッド:updateItemInfo
商品情報を更新し、結果XML文字列を返却する。
REST API / HTTP Method
REST API | HTTP Method |
---|---|
https://api.manager.wowma.jp/wmshopapi/updateItemInfo | POST |
Request
Header
No | Key | Value | Note |
---|---|---|---|
1 | Authorization | Bearer “アプリケーションキー” | 認証方式と”APIキー”を設定 |
2 | Content-Type | application/xml; charset=utf-8 |
Body (INPUT)
No | 分類 | プロパティ名 | Element | 必須 | 型 | byte | 説明 |
---|---|---|---|---|---|---|---|
1 | 共通 | リクエスト | request | ◎ | group | – | – |
2 | 共通 | 店舗ID | request.shopId | ◎ | long | 18 | 半角数字:18桁 各店舗様へ割り振られた会員番号 |
3 | 個別 | 更新商品 | request.updateItem | ◎ | group | – | – |
4 | 個別 | ロットナンバー | request.updateItem.lotNumber | ○ | long | 18 | 半角数字:18桁 更新不可項目 ロットナンバーに値が設定されている場合には、そのロットナンバーの商品を更新する。 ロットナンバーに値を設定しない場合には、商品コードが必須となる。 ※ 新店舗マイページでは、ロットナンバー未発行の場合があるが、 その場合には、商品コードを条件に設定する。 |
5 | 個別 | 商品名 | request.updateItem.itemName | – | string | 128 | 全角:64桁 半角:128桁 |
6 | 個別 | 管理用ID | request.updateItem.itemManagementId | – | string | 128 | 全角:64桁 半角:128桁 |
7 | 個別 | 管理用商品名 | request.updateItem.itemManagementName | – | string | 128 | 全角:64桁 半角:128桁 |
8 | 個別 | 商品コード | request.updateItem.itemCode | ○ | string | 256 | 全角:128桁 半角:256桁 更新不可項目 店舗内の商品でユニークな項目 ・ロットナンバーが設定されていない場合 商品コードが必須項目となり、指定した商品コードの商品を更新する。 |
9 | 個別 | 販売価格 | request.updateItem.itemPrice | – | string | 19 | 半角数字:19桁 半角数字。カンマや\マークの入力不可。 |
10 | 個別 | 販売方法区分 | request.updateItem.sellMethodSegment | – | string | 1 | 説明欄の値のみ 販売方法区分を設定する 1:通常販売 2:予約販売 |
11 | 個別 | 発売(入荷)予定日 | request.updateItem.releaseDate | ○ | string | 8 | 説明欄のフォーマットのみ 発売(入荷)予定日を設定する(yyyyMMdd) 販売方法区分が”2:予約販売”の場合、必須となる。 予約登録日より15日後から1年先までの日付を入力する。 |
12 | 個別 | 税区分 | request.updateItem.taxSegment | – | string | 1 | 説明欄の値のみ 1:内税 2:税なし |
15 | 個別 | 送料設定区分 | request.updateItem.postageSegment | – | string | 1 | 説明欄の値のみ 1:送料別 2:送料込み 3:個別送料 |
16 | 個別 | 個別送料 | request.updateItem.postage | ○ | string | 19 | 半角数字:19桁 [送料設定区分]が個別送料の時のみ設定する。 |
17 | 個別 | (旧)配送方法 | request.updateItem.deliverys | – | group | – | 配送方法を指定する。 |
18 | 個別 | (旧)配送方法ID | request.updateItem.deliverys.deliveryId | – | string | 1 | 半角のみ:1桁 [配送方法]がメール便の時、”M”(メール便)をセットする |
19 | 個別 | (旧)配送方法順序 | request.updateItem.deliverys.deliverySeq | – | string | 1 | 半角数字:1桁 [利用配送方法ID]にMを入力した場合、固定値”1″をセットする |
20 | 個別 | (新)配送方法 | request.updateItem.deliveryMethod | – | group | – | (新)配送方法を指定する(最大5個) 配送方法の順序を変えたい場合は、変更したい配送方法を指定する。 配送方法には「コンビニ受取」と、「クール便」および「大型宅配便」を同時に設定することはできません。 |
21 | 個別 | (新)配送方法ID | request.updateItem.deliveryMethod.deliveryMethodId | – | string | 10 | 全角:5桁 半角:10桁 (新)配送方法順序の配送方法ID(店舗側で設定できる値) (例:TAKUHAI)を指定する。 “NULL”を指定した場合、対象の配送方法は削除され、削除した分の配送方法を詰めて登録する。 |
22 | 個別 | (新)配送方法順序 | request.updateItem.deliveryMethod.deliveryMethodSeq | ○ | string | 1 | 半角数字:1桁 (新)配送方法の順序(1~5)を指定する。 [配送方法ID]が入力されている場合、必須項目となる。 |
23 | 個別 | ギフト包装・ギフトメッセージ区分 | request.updateItem.giftPackingSegment | – | string | 1 | 1:不可 2:可 ※NULLクリア不可 ※指定がない場合は[1:不可]とする |
24 | 個別 | のし区分 | request.updateItem.noshiSegment | – | string | 1 | 1:不可 2:可 ※NULLクリア不可 ※指定がない場合は[1:不可]とする |
25 | 個別 | 最大購入設定区分 | request.updateItem.limitedOrderSegment | – | string | 1 | 説明欄の値のみ 1:指定なし 2:指定あり |
26 | 個別 | 最大購入個数 | request.updateItem.limitedOrderCount | ○ | string | 5 | 半角数字:5桁 [最大購入設定区分]で「指定あり」が選択されている場合のみ設定する。 |
27 | 個別 | 商品説明(共通) | request.updateItem.description | – | string | 1024 | 全角:512桁 半角:1024桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
28 | 個別 | SP用商品説明 | request.updateItem.descriptionForSP | – | string | 10240 | 全角:5120桁 半角:10240桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
29 | 個別 | PC用商品説明 | request.updateItem.descriptionForPC | – | string | 10240 | 全角:5120桁 半角:10240桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
30 | 個別 | 商品詳細タイトル | request.updateItem.detailTitle | – | string | 20 | 全角:10桁 半角:20桁 |
31 | 個別 | 商品詳細説明 | request.updateItem.detailDescription | – | string | 640 | 全角:320桁 半角:640桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
32 | 個別 | スペック | request.updateItem.specs | – | group | – | スペック情報 |
33 | 個別 | スペックタイトル | request.updateItem.specs.specTitle | – | string | 16 | 全角:8桁 半角:16桁 |
34 | 個別 | 詳細スペック | request.updateItem.specs.detailSpecs | – | group | – | スペック項目と値を指定する。 (最大5個) |
35 | 個別 | スペック名 | request.updateItem.specs.detailSpecs.specName | – | string | 16 | 全角:8桁 半角:16桁 |
36 | 個別 | スペック値 | request.updateItem.specs.detailSpecs.spec | – | string | 20 | 全角:10桁 半角:20桁 |
37 | 個別 | スペック項目順序 | request.updateItem.specs.detailSpecs.specSeq | – | string | 1 | 半角数字:1桁 |
38 | 個別 | 検索キーワード | request.updateItem.searchKeywords | – | group | – | 検索キーワードを指定する。 (最大3個) |
39 | 個別 | 検索キーワード | request.updateItem.searchKeywords.searchKeyword | – | string | 20 | 全角:10桁 半角:20桁 |
40 | 個別 | 検索キーワード順序 | request.updateItem.searchKeywords.searchKeywordSeq | – | string | 1 | 半角数字:1桁 |
41 | 個別 | 画像 | request.updateItem.images | – | group | – | 画像のURLと名称を指定する。 (最大10個) |
42 | 個別 | 商品画像URL | request.updateItem.images.imageUrl | – | string | 128 255 |
全角:64桁 半角:128桁 半角:255桁 |
43 | 個別 | 商品画像名 | request.updateItem.images.imageName | – | string | 16 | 全角:8桁 半角:16桁 |
44 | 個別 | 商品画像順序 | request.updateItem.images.imageSeq | – | string | 2 | 半角数字:2桁 |
45 | 個別 | カテゴリID | request.updateItem.categoryId | – | string | 20 | 全角:10桁 半角:20桁 |
46 | 個別 | 検索タグ | request.updateItem.tags | – | group | – | タグを指定する。 (最大64個) |
47 | 個別 | 検索タグID | request.updateItem.tags.tagId | – | string | 20 | 全角:10桁 半角:20桁 |
48 | 個別 | 店舗内カテゴリ | request.updateItem.shopCategory | – | group | – | 店舗内カテゴリを指定する。 (最大10個) ※NULLクリア可 |
49 | 個別 | 店舗内カテゴリ名(フルパス) | request.updateItem.shopCategory.shopCategoryName | – | string | 967 | 1つのカテゴリ:全角半角を問わず60文字以内 区切り文字は「\」「:」とする 半角・全角スペースを区切り文字前後に入れた場合は取り除く |
50 | 個別 | 店舗内カテゴリ表示順位 | request.updateItem.shopCategoryDispSeq | – | string | 9 | 数字のみ(1~999,999,999) 店舗内カテゴリを設定せずに、店舗内カテゴリ表示順位に値を設定することはできません ※NULLクリア可 ※店舗内カテゴリの設定がある、且つ該当項目がNULLの場合、100を入れる |
51 | 個別 | JANコード | request.updateItem.jan | – | string | 13 | 半角数字:13桁 |
52 | 個別 | ISBNコード | request.updateItem.isbn | – | string | 13 | 半角数字:13桁 |
53 | 個別 | 型番 | request.updateItem.itemModel | – | string | 200 | 全角:100桁 半角:200桁 |
54 | 個別 | パスワード制限設定 | request.updateItem.limitedPasswd | – | string | 100 | 全角:50桁 半角:100桁 |
55 | 個別 | パスワード制限ページタイトル | request.updateItem.limitedPasswdPageTitle | – | string | 200 | 全角:100桁 半角:200桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
56 | 個別 | パスワード制限ページメッセージ | request.updateItem.limitedPasswdPageMessage | – | string | 320 | 全角:160桁 半角:320桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
57 | 個別 | 販売ステータス | request.updateItem.saleStatus | – | string | 1 | 説明欄の値のみ 1:販売中商品 2:販売終了商品 |
58 | 個別 | 購入オプション | request.updateItem.itemOptions | – | group | – | 購入オプションを指定する。 (最大20個) |
59 | 個別 | 購入オプションタイトル | request.updateItem.itemOptions.itemOptionTitle | – | string | 256 | 全角:128桁 半角:256桁 |
60 | 個別 | 購入オプション選択肢 | request.updateItem.itemOptions.itemOption | – | string | 2000 | 全角:981桁 半角:1962桁 |
61 | 個別 | 購入オプション順序 | request.updateItem.itemOptions.itemOptionSeq | – | string | 1 | 半角数字:1桁 |
62 | 個別 | 購入オプション(手数料型) | request.updateItem.itemOptionCommissions | – | group | – | 購入オプション(手数料型)を指定する。 (最大20個) ※NULLクリアの場合、タイトルや値や注意事項をすべてNULLで指定する |
63 | 個別 | 購入オプション(手数料型)タイトル | request.updateItem.itemOptionCommissions.itemOptionCommissionTitle | – | string | 256 | – |
64 | 個別 | 購入オプション(手数料型)値 | request.updateItem.itemOptionCommissions.itemOptionCommissionVal | – | group | – | 購入オプション(手数料型)の選択肢・価格を指定する。 (最大10個) ※NULLクリアの場合、順序を設定し、選択肢と価格を両方NULLで指定する |
65 | 個別 | 購入オプション(手数料型)選択肢 | request.updateItem.itemOptionCommissions.itemOptionCommissionVal.itemOptionCommission | – | string | 200 | – |
66 | 個別 | 購入オプション(手数料型)価格 | request.updateItem.itemOptionCommissions.itemOptionCommissionVal.itemOptionCommissionPrice | – | string | 13 | – |
67 | 個別 | 購入オプション(手数料型)選択肢・価格順序 | request.updateItem.itemOptionCommissions.itemOptionCommissionVal.itemOptionCommissionValSeq | – | string | 2 | – |
68 | 個別 | 購入オプション(手数料型)注意事項 | request.updateItem.itemOptionCommissions.itemOptionCommissionNote | – | string | 2000 | 改行可能 |
69 | 個別 | 購入オプション(手数料型)順序 | request.updateItem.itemOptionCommissions.itemOptionCommissionSeq | – | string | 2 | – |
70 | 個別 | ポイント倍率 | request.updateItem.pointRate | – | string | 2 | 半角数字:2桁 1~20倍を指定可能 |
71 | 個別 | 入荷リクエスト設定 | request.updateItem.stockRequestConfig | – | string | 1 | 説明欄の値のみ 1:受け付ける 2:受け付けない ※NULLクリア不可 ※指定がない場合は[1:受け付ける]とする |
72 | 個別 | 更新在庫 | request.updateStock | – | group | – | 通常在庫または選択肢別在庫の登録情報を指定する。 |
73 | 個別 | 在庫区分 | request.updateStock.stockSegment | ※ | string | 1 | 説明欄の値のみ 1:通常在庫 2:選択肢別在庫 |
74 | 個別 | 通常在庫数 | request.updateStock.stockCount | ※ | string | 6 | 半角数字5桁 記号(+,-)を使用する場合のみ6桁を許容します 更新する在庫数を指定 ・数値にプラス記号「+」が付いている場合は加算、 マイナス記号「-」が付いている場合は減算します。 ・数値のみの場合はその値で更新します。(1:通常在庫の場合のみ指定) ・在庫数が0の場合「販売ステータス」を「販売終了」に更新します。 ・在庫数は最大5桁で入力してください。 ※記号(+,-)を使用する場合のみ6桁を許容します。( 記号(1桁)+在庫数(5桁) ) |
75 | 個別 | 通常在庫発送日ID | request.updateStock.stockShippingDayId | ※ | string | 10 | 全角:5桁 半角:10桁 文字列(登録している発送日ID(店舗側で設定できる値)を指定する。 英数字、ハイフン、アンダースコアのみ可。半角10文字以内。) |
76 | 個別 | 残在庫表示区分 | request.updateStock.displayStockSegment | ※ | string | 1 | 説明欄の値のみ 1:在庫数を表示しない。 2:在庫数を表示する。 3:指定した在庫数以下の場合表示する。 |
77 | 個別 | 在庫表示閾値 | request.updateStock.displayStockThreshold | ※ | string | 5 | 半角数字:5桁 [残在庫表示区分]が「指定した在庫数以下の場合表示する。」が 選択されている場合のみ設定する。 |
78 | 個別 | 選択肢別在庫横軸項目名 | request.updateStock.choicesStockHorizontalItemName | ※ | string | 50 | 全角:25桁 半角:50桁 |
79 | 個別 | 選択肢別在庫横軸 | request.updateStock.choicesStockHorizontals | ※ | group | – | 選択肢別在庫の横軸設定 (最大20個) |
80 | 個別 | 選択肢別在庫横軸コード | request.updateStock.choicesStockHorizontals.choicesStockHorizontalCode | ※ | string | 255 | 半角のみ:255桁 |
81 | 個別 | 選択肢別在庫横軸名 | request.updateStock.choicesStockHorizontals.choicesStockHorizontalName | ※ | string | 100 | 全角:50桁 半角:100桁 |
82 | 個別 | 選択肢別在庫横軸順序 | request.updateStock.choicesStockHorizontals.choicesStockHorizontalSeq | ※ | string | 2 | 半角数字:2桁 |
83 | 個別 | 選択肢別在庫縦軸項目名 | request.updateStock.choicesStockVerticalItemName | ※ | string | 50 | 全角:25桁 半角:50桁 |
84 | 個別 | 選択肢別在庫縦軸 | request.updateStock.choicesStockVerticals | ※ | group | – | 選択肢別在庫の縦軸設定 (最大40個) |
85 | 個別 | 選択肢別在庫縦軸コード | request.updateStock.choicesStockVerticals.choicesStockVerticalCode | ※ | string | 255 | 半角のみ:255桁 |
86 | 個別 | 選択肢別在庫縦軸名 | request.updateStock.choicesStockVerticals.choicesStockVerticalName | ※ | string | 100 | 全角:50桁 半角:100桁 |
87 | 個別 | 選択肢別在庫縦軸順序 | request.updateStock.choicesStockVerticals.choicesStockVerticalSeq | ※ | string | 2 | 半角数字:2桁 |
88 | 個別 | 選択肢別在庫 | request.updateStock.choicesStocks | ※ | group | – | 選択肢別在庫の在庫数の設定 (最大20×40=800個) |
89 | 個別 | 選択肢別在庫横軸コード | request.updateStock.choicesStocks.choicesStockHorizontalCode | ※ | string | 255 | 半角のみ:255桁 |
90 | 個別 | 選択肢別在庫縦軸コード | request.updateStock.choicesStocks.choicesStockVerticalCode | ※ | string | 255 | 半角のみ:255桁 |
91 | 個別 | 選択肢別在庫数 | request.updateStock.choicesStocks.choicesStockCount | ※ | string | 6 | 半角数字5桁 記号(+,-)を使用する場合のみ6桁を許容します 更新する在庫数を指定 ・数値にプラス記号「+」が付いている場合は加算、 マイナス記号「-」が付いている場合は減算します。 ・数値のみの場合はその値で更新します。(2:選択肢別在庫の場合のみ指定) ・選択肢すべての在庫数が0の場合、「販売ステータス」を「販売終了」に更新します。 ・在庫数は最大5桁で入力してください。 ※記号(+,-)を使用する場合のみ6桁を許容します。( 記号(1桁)+在庫数(5桁) ) |
92 | 個別 | 選択肢別在庫発送日ID | request.updateStock.choicesStocks.choicesStockShippingDayId | ※ | string | 10 | 全角:5桁 半角:10桁 文字列(登録している発送日ID(店舗側で設定できる値)を指定する。 英数字、ハイフン、アンダースコアのみ可。半角10文字以内。) |
93 | 個別 | 選択肢別在庫上説明 | request.updateStock.choicesStockUpperDescription | ※ | string | 250 | 全角:125桁 半角:250桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
94 | 個別 | 選択肢別在庫下説明 | request.updateStock.choicesStockLowerDescription | ※ | string | 250 | 全角:125桁 半角:250桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
95 | 個別 | 残選択肢別在庫表示区分 | request.updateStock.displayChoicesStockSegment | ※ | string | 1 | 説明欄の値のみ 1:在庫数を表示しない。 2:在庫数を表示する。 3:指定した在庫数以下の場合、「△」を表示。 |
96 | 個別 | 選択肢別在庫表示閾値 | request.updateStock.displayChoicesStockThreshold | ※ | string | 5 | 半角数字:5桁 [残在庫表示区分]が「指定した在庫数以下の場合表示する。」が 選択されている場合のみ設定する。 |
97 | 個別 | 在庫切れメッセージ | request.updateStock.displayBackorderMessage | ※ | string | 64 | 全角:32桁 半角:64桁 |
Response
Header
No | Key | Value | Note |
---|---|---|---|
1 | Content-Type | application/xml; charset=utf-8 | 認証方式と”APIキー”を設定 |
Body (OUTPUT)
No | 分類 | プロパティ名 | Element | 型 | byte | 説明 | 正常時 | 異常時 |
---|---|---|---|---|---|---|---|---|
1 | 共通 | レスポンス | response | group | – | – | – | – |
2 | 共通 | 処理結果 | response.result | string | – | – | – | – |
3 | 共通 | 処理結果コード | response.result.status | string | 1 | 0:成功 1:失敗 |
– | – |
4 | 個別 | 処理結果詳細 | response.updateResult | group | – | – | 〇 | 〇 |
5 | 個別 | ロットナンバー | response.updateResult.lotNumber | long | 20 | 登録した商品のロットナンバーを設定する。 ※ 現状では、ロットナンバーの発行を現行システムから連携される想定のため、 本APIでは、設定されない。 |
〇 | 〇 |
6 | 個別 | 商品コード | response.updateResult.itemCode | string | 256 | 登録した商品の商品コードを設定する。 | 〇 | 〇 |
7 | 個別 | エラー情報 | response.updateResult.error | group | – | – | – | 〇 |
8 | 個別 | エラーコード | response.updateResult.error.code | string | 7 | メッセージ一覧のメッセージIDを参照。 | – | 〇 |
9 | 個別 | エラーメッセージ | response.updateResult.error.message | string | 1000 | メッセージ一覧の詳細メッセージを参照。 | – | 〇 |
-
前の記事
Wowma!API:商品情報更新API(Ver.複数) 2018.09.24
-
次の記事
Wowma!API:出品商品の在庫情報を取得 2018.09.24
コメントを残す