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