楽天市場API:商品情報を更新する(Ver.複数) 

楽天市場API:商品情報を更新する(Ver.複数) 

出品中の商品情報を更新するAPI(Ver.複数)

店舗運営で最も使うAPI。検索対策に価格調整にと使用頻度が高い商品情報更新のAPIには単品と複数同時更新とで2タイプが用意されています。

  1. item.update:1件づつ処理する更新API。変更可能な範囲が広い
  2. items.update:20件までまとめて処理できる更新API。変更可能箇所は限定的

ここでは20件までまとめて処理できる items.update の情報を記載します。

APIメソッド:items.update

この機能を利用すると、RMSに登録されている複数の商品情報を同時に更新することができます。

Endpoint / HTTP Method

Endpoint HTTP Method
https://api.rms.rakuten.co.jp/es/1.0/items/update POST

Request

HTTP Header
No Key Value Note
1 Authorization ESA Base64(serviceSecret:licenseKey)
HTTP Body
XML:request
No Element Description Type Size(byte) Mandatory Multiplicity Note
1 request.itemsUpdateRequest 商品情報リスト更新要求 XML:itemsUpdateRequest 1
XML:itemsUpdateRequest
No Element Description Type Size(byte) Mandatory Multiplicity Note
1 itemsUpdateRequest.items 商品情報リスト XML : items 1
XML:items
No Element Description Type Size(byte) Mandatory Multiplicity Note
1 items.item 商品情報 XML : item 1…20
XML:item
No Element Description Type 最大Size(Byte) Mandatory Multiplicity Note
1 item.itemUrl 商品管理番号 String 255 1 ItemUrl(商品管理番号)を設定(必須)。
1文字での登録は不可。
ほかの商品と重複不可。
ItemUrlの入力形式:^[0-9a-z\-_]+$
全角・大文字を半角に自動的に変換。
2 item.itemNumber 商品番号 String 32 0,1 <br> 可。
全角文字利用可。
3 item.itemName 商品名 String 255 0,1 <br> 可。
外部リンク不可。
全半角スペースをtrim
4 item.itemPrice 販売価格 int 4 0,1 許容値:0~999999999
「,」「¥」「円」は自動的に削除して登録
全角を半角に自動的に変換。
5 item.genreId 全商品ディレクトリID int 4 0,1 許容値:100000~999999
全角を半角に自動的に変換。
IDの値はNavigationAPIのnavigation.genre.getをご利用いただくことで、下記の項目から取得可能です。
3.2.3. XML:genre – genreId
6 item.catalogId カタログID String 30 0,1 入力必須対象ジャンルの全商品ディレクトリIDの商品情報を更新する場合に入力必須。
HTMLタグ入力不可
全角文字利用可。
0 もしくは null を入力すると削除。
7 item.catalogIdExemptionReason カタログIDなしの理由 int 4 0,1 「カタログID」入力必須対象ジャンルの商品にカタログIDを入力できない場合は入力必須。
設定内容:
1:セット商品
2:サービス商品
3:店舗オリジナル商品
4:項目選択肢別在庫商品
5: 該当製品コードなし
※各項目の詳細については こちらを参照ください。
0 もしくは null を入力すると削除。
8 item.whiteBgImageUrl 白背景画像URL String 255 0,1 任意項目。削除したい場合は空欄にする。
画像は1枚のみ登録可能。
HTTPSのみ入力可。HTTPは入力不可。
9 item.catchCopyForPC PC用キャッチコピー String 174 0,1 外部リンク不可。
Multiline 可。
URLにはHTTPSのみ入力可。HTTPは入力不可。
10 item.catchCopyForMobile モバイル用キャッチコピー String 60 0,1 外部リンク不可。
Multiline 可。
11 item.displayMakerContents メーカー提供コンテンツ表示 boolean 0,1 デフォルト値:false
true:表示する
false:表示しない
12 item.isIncludedTax 消費税 boolean 0,1 デフォルト値:true
true:消費税込
false:消費税別
13 item.isIncludedPostage 送料 boolean 0,1 デフォルト値:false
true:送料込
false:送料別
14 item.displayPrice 表示価格 int 4 0,1 -999:オープン価格
1-999999999:表示価格許容値
全角を半角に自動的に変換。
15 item.isUnavailableForSearch サーチ非表示 boolean 0,1 デフォルト値:false
false:表示する
true:表示しない
16 item.isAvailableForMobile モバイル表示 boolean 0,1 デフォルト値:true
true:表示する
false:表示しない
2015年8月6日(木)よりモバイル非表示機能がなくなることにより、「モバイル表示」項目へ入力された値は参照されません。
※システム上では「モバイル表示」項目の値を参照および更新しないことになりますので、値を入れてもエラーにはなりません。
17 item.isDepot 倉庫指定 boolean 0,1 デフォルト値:false
true:倉庫に入れる
false:販売中
全角を半角に自動的に変換。
18 item.deliverySetId 配送方法セット管理番号 int 4 0,1 デフォルト値:null
0: 配送方法セット管理番号を設定しない or 自動選択配送方法セットを利用する
1以上の数字: 配送方法セット管理番号を設定する
許容値: 1~20
19 item.categories カテゴリ情報リスト 0,1
20 item.categories.categoryInfo カテゴリ情報 0..n
21 item.categories.categoryInfo.categorySetManageNumber カテゴリセット管理番号 String 20 0,1 ※ メガショッププランの店舗様のみご利用いただける項目となります。
22 item.categories.categoryInfo.categoryId カテゴリID int 4 0,1 デフォルト値:1
IDの値はCategoryAPI のshop.categories.getをご利用いただくことで、下記の項目から取得可能です。
3.2.4. XML:category – categoryId
23 item.categories.categoryInfo.isPluralItemPage 複数表示形式 boolean 0,1 デフォルト値:false
24 item.itemWeight 表示優先度 int 4 0,1 デフォルト値:999999999
許容値:1~999999999
25 tem.layoutCommonId ヘッダー・フッター・レフトナビのテンプレートID int 4 0,1 デフォルト値:0
IDの値はShopManagementAPIのshop.dsgn.navitemplate.list.getをご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:shopLayoutCommon – layoutCommonId
26 item.layoutMapId 表示項目の並び順のテンプレートID int 4 0,1 デフォルト値:0
IDの値はShopManagementAPIのshop.dsgn.itempage.tmpl.list.getをご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:layoutItemMap – itemMapId
27 item.textSmallId 共通説明文(小)のテンプレートID int 4 0,1 デフォルト値:0
IDの値はShopManagementAPIのshop.dsgn.description.s.list.getをご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:layoutTextSmall – textSmallId
28 item.lossLeaderId 目玉商品のテンプレートID int 4 0,1 デフォルト値:0
IDの値はShopManagementAPIのshop.dsgn.featured.item.list.getをご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:layoutLossLeader – lossLeaderId
29 item.textLargeId 共通説明文(大)のテンプレートID int 4 0,1 デフォルト値:0
IDの値はShopManagementAPIのshop.dsgn.description.l.list.getをご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:layoutTextLarge – textLargeId

Response

HTTP Header
No Key Value Note
1 Content-Type text/xml
HTTP Body
XML:result
No Element Description Type Size(byte) Multiplicity Note
1 result.status ステータス XML : status 1 interfaceId=items.update
2 result.itemsUpdateResult 商品情報リスト更新結果 XML : itemsUpdateResult 1
XML:itemsUpdateResult
No Element Description Type Size(byte) Multiplicity Note
1 itemsUpdateResultList.itemUpdateResult 商品情報更新結果 XML : itemUpdateResult 0…n
XML:itemUpdateResult
No Element Description Type Size(byte) Multiplicity Note
1 itemUpdateResult.code 結果コード String 1 詳細は、 ItemAPI Response Codes Reference を参照してください。
2 itemUpdateResult.errorMessages エラーメッセージリスト XML : errorMessages
3 itemUpdateResult.item 商品情報 XML : item
XML:errorMessages
No Element Description Type Size(byte) Multiplicity Note
1 errorMessages.errorMessage エラーメッセージ XML : errorMessage 0…n
XML:errorMessage
No Element Description Type Size (byte) Multiplicity Note
1 errorMessage.errorId エラーID String 255 1 詳細は「ErrorMessage Definition 1.errorId list」参照
2 errorMessage.fieldId 項目ID String 255 1 詳細は「ErrorMessage Definition 3.fieldId list」参照
3 errorMessage.msg メッセージ String 255 1
4 errorMessage.listIndex エラーが発生したリストのIndex Int 2 0,1 List形式の項目についてエラーが発生した際に返却され、エラーが発生したのが何番目のリストかを示す値です。※
5 errorMessage.listIndex2 エラーが発生したリスト内のIndex Int 2 0,1 listIndexがあり、かつその対象項目が複数の要素を持つ場合に何番目の要素かを示す値です。※
XML:item
No Element Description Type Size(byte) Multiplicity Note
1 item.itemUrl 商品管理番号 String 255