Wowma!API:商品情報更新API(Ver.複数)

目次
Wow!managerの商品情報をまとめて更新するAPI
出品中の商品情報をまとめて更新するAPI。在庫更新と合わせ利用頻度が多いと思われる。更新できる項目数は少ないが、検索キーワードや商品名などSEO的に変えたいパートは網羅している。商品サイズなどスペックに関する更新項目が無いのが残念だった。
APIメソッド:updateItemInfos
商品情報を更新し、結果XML文字列を返却する。
REST API / HTTP Method
REST API | HTTP Method |
---|---|
https://api.manager.wowma.jp/wmshopapi/updateItemInfos | 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.updateItemInfo | ◎ | group | – | 更新する商品の数だけ作成する。(最大100件) | |||||||
4 | 個別 | ロットナンバー | request.updateItemInfo.lotNumber | ○ | long | 18 | 半角数字:18桁 更新不可項目 ロットナンバーに値が設定されている場合には、そのロットナンバーの商品を更新する。 ロットナンバーに値を設定しない場合には、商品コードが必須となる。 ※ 新店舗マイページでは、ロットナンバー未発行の場合があるが、 その場合には、商品コードを条件に設定する。 |
|||||||
5 | 個別 | 商品コード | request.updateItemInfo.itemCode | ○ | string | 256 | 全角:128桁 半角:256桁 店舗内の商品でユニークな項目 ・ロットナンバーが設定されていない場合 商品コードが必須項目となり、指定した商品コードの商品を更新する。 |
|||||||
6 | 個別 | 商品名 | request.updateItemInfo.itemName | – | string | 128 | 全角:64桁 半角:128桁 |
|||||||
7 | 個別 | 管理用ID | request.updateItemInfo.itemManagementId | – | string | 128 | 全角:64桁 半角:128桁 |
|||||||
8 | 個別 | 管理用商品名 | request.updateItemInfo.itemManagementName | – | string | 128 | 全角:64桁 半角:128桁 |
|||||||
9 | 個別 | 販売価格 | request.updateItemInfo.itemPrice | – | string | 19 | 半角数字:19桁 半角数字。カンマや\マークの入力不可。 |
|||||||
10 | 個別 | 販売方法区分 | request.updateItemInfo.sellMethodSegment | – | string | 1 | 説明欄の値のみ 販売方法区分を設定する 1:通常販売 2:予約販売 |
|||||||
11 | 個別 | 発売(入荷)予定日 | request.updateItemInfo.releaseDate | ○ | string | 8 | 説明欄のフォーマットのみ 発売(入荷)予定日を設定する(yyyyMMdd) 販売方法区分が”2:予約販売”の場合、必須となる。 予約登録日より15日後から1年先までの日付を入力する。 |
|||||||
12 | 個別 | 送料設定区分 | request.updateItemInfo.postageSegment | – | string | 1 | 説明欄の値のみ 1:送料別 2:送料込み 3:個別送料 |
|||||||
15 | 個別 | 個別送料 | request.updateItemInfo.postage | – | string | 19 | 半角数字:19桁 [送料設定区分]が個別送料の時のみ設定する。 |
|||||||
16 | 個別 | 検索キーワード | request.updateItemInfo.searchKeywords | – | group | – | 検索キーワードを指定する。 (最大3個) |
|||||||
17 | 個別 | 検索キーワード | request.updateItemInfo.searchKeyword | – | string | 20 | 全角:10桁 半角:20桁 |
|||||||
18 | 個別 | 検索キーワード順序 | request.updateItemInfo.searchKeywordSeq | – | string | 1 | 半角数字:1桁 | |||||||
19 | 個別 | カテゴリID | request.updateItemInfo.categoryId | – | string | 20 | 全角:10桁 半角:20桁 |
|||||||
20 | 個別 | 店舗内カテゴリ | request.updateItemInfo.shopCategory | – | group | – | 店舗内カテゴリを指定する。 (最大10個) ※NULLクリア可 |
|||||||
21 | 個別 | 店舗内カテゴリ名(フルパス) | request.updateItemInfo.shopCategory.shopCategoryName | – | string | 967 | 1つのカテゴリ:全角半角を問わず60文字以内 区切り文字は「\」「:」とする 半角・全角スペースを区切り文字前後に入れた場合は取り除く |
|||||||
22 | 個別 | 店舗内カテゴリ表示順位 | request.updateItemInfo.shopCategoryDispSeq | – | string | 9 | 数字のみ(1~999,999,999) 店舗内カテゴリを設定せずに、店舗内カテゴリ表示順位に値を設定することはできません ※NULLクリア可 ※店舗内カテゴリの設定がある、且つ該当項目がNULLの場合、100を入れる |
|||||||
23 | 個別 | 型番 | request.updateItemInfo.itemModel | – | string | 200 | 全角:100桁 半角:200桁 |
|||||||
24 | 個別 | 販売ステータス | request.updateItemInfo.saleStatus | – | string | 1 | 説明欄の値のみ 1:販売中商品 2:販売終了商品 |
|||||||
25 | 個別 | ポイント倍率 | request.updateItemInfo.pointRate | – | string | 2 | 半角数字:2桁 半角数字。1~20倍を指定可能 |
|||||||
26 | 個別 | 入荷リクエスト設定 | request.updateItemInfo.stockRequestConfig | – | string | 1 | 1:受け付ける 2:受け付けない ※NULLクリア不可 ※指定がない場合は[1:受け付ける]とする |
|||||||
27 | 個別 | (新)配送方法 | request.updateItemInfo.deliveryMethod | – | group | – | (新)配送方法を指定する(最大5個) 配送方法の順序を変えたい場合は、変更したい配送方法を指定する。 配送方法には「コンビニ受取」と、「クール便」および「大型宅配便」を同時に設定することはできません。 |
|||||||
28 | 個別 | (新)配送方法ID | request.updateItemInfo.deliveryMethod.deliveryMethodId | – | string | 10 | 全角:5桁 半角:10桁 (新)配送方法順序の配送方法ID(店舗側で設定できる値) (例:TAKUHAI)を指定する。 “NULL”を指定した場合、対象の配送方法は削除され、削除した分の配送方法を詰めて登録する。 |
|||||||
29 | 個別 | (新)配送方法順序 | request.updateItemInfo.deliveryMethod.deliveryMethodSeq | ○ | string | 1 | 半角数字:1桁 (新)配送方法の順序(1~5)を指定する。 [配送方法ID]が入力されている場合、必須項目となる。 |
|||||||
30 | 個別 | ギフト包装・ギフトメッセージ区分 | request.updateItemInfo.giftPackingSegment | – | string | 1 | 1:不可 2:可 ※NULLクリア不可 ※指定がない場合は[1:不可]とする |
|||||||
31 | 個別 | のし区分 | request.updateItemInfo.noshiSegment | – | string | 1 | 1:不可 2:可 ※NULLクリア不可 ※指定がない場合は[1:不可]とする |
|||||||
32 | 個別 | 購入オプション | request.updateItemInfo.itemOptions | – | group | – | 購入オプションを指定する。 (最大20個) |
|||||||
33 | 個別 | 購入オプションタイトル | request.updateItemInfo.itemOptions.itemOptionTitle | – | string | 256 | 全角:128桁 半角:256桁 |
|||||||
34 | 個別 | 購入オプション選択肢 | request.updateItemInfo.itemOptions.itemOption | – | string | 2000 | 全角:981桁 半角:1962桁 |
|||||||
35 | 個別 | 購入オプション順序 | request.updateItemInfo.itemOptions.itemOptionSeq | – | string | 2 | 半角数字:2桁 | |||||||
36 | 個別 | 購入オプション(手数料型) | request.updateItemInfo.itemOptionCommissions | – | group | – | 購入オプション(手数料型)を指定する。 (最大20個) ※NULLクリアの場合、タイトルや値や注意事項をすべてNULLで指定する |
|||||||
37 | 個別 | 購入オプション(手数料型)タイトル | request.updateItemInfo.itemOptionCommissions.itemOptionCommissionTitle | – | string | 256 | – | |||||||
38 | 個別 | 購入オプション(手数料型)値 | request.updateItemInfo.itemOptionCommissions.itemOptionCommissionVal | – | group | – | 購入オプション(手数料型)の選択肢・価格を指定する。 (最大10個) ※NULLクリアの場合、順序を設定し、選択肢と価格を両方NULLで指定する |
|||||||
39 | 個別 | 購入オプション(手数料型)選択肢 | request.updateItemInfo.itemOptionCommissions.itemOptionCommissionVal.itemOptionCommission | – | string | 200 | – | |||||||
40 | 個別 | 購入オプション(手数料型)価格 | request.updateItemInfo.itemOptionCommissions.itemOptionCommissionVal.itemOptionCommissionPrice | – | string | 13 | – | |||||||
41 | 個別 | 購入オプション(手数料型)選択肢・価格順序 | request.updateItemInfo.itemOptionCommissions.itemOptionCommissionVal.itemOptionCommissionValSeq | – | string | 2 | – | |||||||
42 | 個別 | 購入オプション(手数料型)注意事項 | request.updateItemInfo.itemOptionCommissions.itemOptionCommissionNote | – | string | 2000 | 改行可能 | |||||||
43 | 個別 | 購入オプション(手数料型)順序 | request.updateItemInfo.itemOptionCommissions.itemOptionCommissionSeq | – | string | 2 | – |
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:商品情報更新API(Ver.シングル) 2018.09.24
コメントを残す