Wowma!API:登録商品の在庫数更新API

目次
Wow!managerの在庫情報を更新するAPI
出品中の商品の在庫情報を更新するAPI。商品関連APIの中で最も利用頻度が高くなる。値の変化だけで通常在庫と選択肢在庫の両方をコントロールできる点がプログラム作りにはありがたい。
APIメソッド:updateStock
指定した商品の出品在庫数(通常および選択肢別)を個数指定で更新する。
REST API / HTTP Method
REST API | HTTP Method |
---|---|
https://api.manager.wowma.jp/wmshopapi/updateStock | 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.stockUpdateItem | group | – | 更新する商品の数だけ作成する。 (最大200件) |
◎ | ◎ |
4 | 個別 | ロットナンバー | request.stockUpdateItem.lotNumber | long | 18 | 半角数字:18桁 更新不可項目 ロットナンバーに値が設定されている場合には、そのロットナンバーの商品を更新する。 ロットナンバーに値を設定しない場合には、商品コードが必須となる。 ※ 新店舗マイページでは、ロットナンバー未発行の場合があるが、 その場合には、商品コードを条件に設定する。 |
○ | ○ |
5 | 個別 | 商品コード | request.stockUpdateItem.itemCode | string | 256 | 全角:128桁 半角:256桁 店舗内の商品でユニークな項目 以下の条件にて、扱いが変化します。 ・ロットナンバーが設定されている場合 更新項目として商品コードに指定された値で更新する。 ・ロットナンバーが設定されていない場合 商品コードが必須項目となり、指定した商品コードの商品を更新する。 |
○ | ○ |
6 | 個別 | 在庫区分 | request.stockUpdateItem.stockSegment | string | 1 | 説明欄の値のみ 1:通常在庫 2:選択肢別在庫 |
◎ | ◎ |
7 | 個別 | 通常在庫数 | request.stockUpdateItem.stockCount | string | 6 | 半角数字5桁 記号(+,-)を使用する場合のみ6桁を許容します 更新する在庫数を指定 ・数値にプラス記号「+」が付いている場合は加算、 マイナス記号「-」が付いている場合は減算します。 ・数値のみの場合はその値で更新します。(1:通常在庫の場合のみ指定) ・在庫数が0の場合「販売ステータス」を「販売終了」に更新します。 ・在庫数は最大5桁で入力してください。 ※記号(+,-)を使用する場合のみ6桁を許容します。( 記号(1桁)+在庫数(5桁) ) |
– | × |
8 | 個別 | 通常在庫発送日ID | request.stockUpdateItem.stockShippingDayId | string | 10 | 全角:5桁 半角:10桁 文字列(登録している発送日ID(店舗側で設定できる値)を指定する。英数字、ハイフン、アンダースコアのみ可。半角10文字以内。) |
– | × |
9 | 個別 | 残在庫表示区分 | request.stockUpdateItem.displayStockSegment | string | 1 | 説明欄の値のみ 1:在庫数を表示しない。 2:在庫数を表示する。 3:指定した在庫数以下の場合表示する。 |
– | × |
10 | 個別 | 在庫表示閾値 | request.stockUpdateItem.displayStockThreshold | string | 5 | 半角数字:5桁 [残在庫表示区分]が 「指定した在庫数以下の場合表示する。」が 選択されている場合、指定可能 |
○ | × |
11 | 個別 | 販売ステータス | request.stockUpdateItem.saleStatus | string | 1 | 説明欄の値のみ 1:販売中商品 2:販売終了商品 |
– | – |
25 | 個別 | 選択肢別在庫横軸項目名 | request.stockUpdateItem.choicesStockHorizontalItemName | string | 100 | 全角:50桁 半角:100桁 横軸のタイトル。 例:色 |
× | – |
12 | 個別 | 選択肢別在庫横軸 | request.stockUpdateItem.choicesStockHorizontals | group | – | 選択肢別在庫の横軸の設定 入力件数:1~20 |
× | – |
13 | 個別 | 選択肢別在庫横軸コード | request.stockUpdateItem.choicesStockHorizontals.choicesStockHorizontalCode | string | 255 | 半角のみ:255桁 例:-R |
× | – |
14 | 個別 | 選択肢別在庫横軸名 | request.stockUpdateItem.choicesStockHorizontals.choicesStockHorizontalName | string | 100 | 全角:50桁 半角:100桁 例:赤 |
× | – |
15 | 個別 | 選択肢別在庫横軸順序 | request.stockUpdateItem.choicesStockHorizontals.choicesStockHorizontalSeq | string | 2 | 半角数字:2桁 選択肢別在庫の横軸の数値。 範囲:1~20 |
× | – |
16 | 個別 | 選択肢別在庫縦軸項目名 | request.stockUpdateItem.choicesStockVerticalItemName | string | 100 | 全角:50桁 半角:100桁 縦軸のタイトル 例:サイズ |
× | – |
17 | 個別 | 選択肢別在庫縦軸 | request.stockUpdateItem.choicesStockVerticals | group | – | 選択肢別在庫の縦軸の設定 入力件数:1~40 |
× | – |
18 | 個別 | 選択肢別在庫縦軸コード | request.stockUpdateItem.choicesStockVerticals.choicesStockVerticalCode | string | 255 | 半角のみ:255桁 例:-S |
× | – |
19 | 個別 | 選択肢別在庫縦軸名 | request.stockUpdateItem.choicesStockVerticals.choicesStockVerticalName | string | 100 | 全角:50桁 半角:100桁 例:S |
× | – |
20 | 個別 | 選択肢別在庫縦軸順序 | request.stockUpdateItem.choicesStockVerticals.choicesStockVerticalSeq | string | 2 | 半角数字:2桁 選択肢別在庫の縦軸の数値。 範囲:1~40 |
× | – |
21 | 個別 | 選択肢別在庫 | request.stockUpdateItem.choicesStocks | group | – | 在庫数の設定(最大20×40=800件) | × | – |
22 | 個別 | 選択肢別在庫横軸コード | request.stockUpdateItem.choicesStocks.choicesStockHorizontalCode | string | 255 | 全角:50桁 半角:100桁 |
× | – |
23 | 個別 | 選択肢別在庫縦軸コード | request.stockUpdateItem.choicesStocks.choicesStockVerticalCode | string | 255 | 全角:50桁 半角:100桁 |
× | – |
24 | 個別 | 選択肢別在庫数 | request.stockUpdateItem.choicesStocks.choicesStockCount | string | 6 | 半角数字5桁 記号(+,-)を使用する場合のみ6桁を許容します 更新する在庫数を指定 ・数値にプラス記号「+」が付いている場合は加算、 マイナス記号「-」が付いている場合は減算します。 ・数値のみの場合はその値で更新します。(2:選択肢別在庫の場合のみ指定) ・選択肢すべての在庫数が0の場合、「販売ステータス」を「販売終了」に更新します。 ・在庫数は最大5桁で入力してください。 ※記号(+,-)を使用する場合のみ6桁を許容します。( 記号(1桁)+在庫数(5桁) ) |
× | – |
25 | 個別 | 選択肢別在庫発送日ID | request.stockUpdateItem.choicesStocks.choicesStockShippingDayId | string | 10 | 全角:5桁 半角:10桁 文字列(登録している発送日ID(店舗側で設定できる値)を指定する。英数字、ハイフン、アンダースコアのみ可。半角10文字以内。) |
× | – |
26 | 個別 | 選択肢別在庫上説明 | request.stockUpdateItem.choicesStockUpperDescription | string | 250 | 全角:125桁 半角:250桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
× | – |
27 | 個別 | 選択肢別在庫下説明 | request.stockUpdateItem.choicesStockLowerDescription | string | 250 | 全角:125桁 半角:250桁 HTML使用可、使用する場合はエスケープすること。エスケープについてはAPI共通仕様参照。 |
× | – |
28 | 個別 | 残選択肢別在庫表示区分 | request.stockUpdateItem.displayChoicesStockSegment | string | 1 | 説明欄の値のみ 1:在庫数を表示しない。 2:在庫数を表示する。 3:指定した在庫数以下の場合、「△」を表示。 |
× | – |
29 | 個別 | 選択肢別在庫表示閾値 | request.stockUpdateItem.displayChoicesStockThreshold | string | 5 | 半角数字:5桁 [残在庫表示区分]が 「指定した在庫数以下の場合表示する。」が 選択されている場合、指定可能 |
× | ○ |
30 | 個別 | 在庫切れメッセージ | request.stockUpdateItem.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 | 登録した商品のロットナンバーを設定する。 | 〇 | 〇 |
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:出品商品の在庫情報を取得 2018.09.24
-
次の記事
面倒な画像加工の自動化を検討する 2018.09.24
コメントを残す