多店舗展開ECシステム開発日誌

多店舗化の命題にシステム化を選択したひとり店長奮闘記

NEW ARTICLE
流行りのChatGPTにWordPressの記事生成をさせてみた

楽天市場API：商品を出品する

楽天市場API：商品を出品する
目次

商品を出品するAPI

コントロールカラムでいう所の【ｎ】をサポートするAPI。商品情報CSVの item.csv の出品API版でほぼすべての設定をこのメソッドでこなせる。

APIメソッド：item.insert

この機能を利用すると、RMSに商品情報を登録することができます。

Endpoint / HTTP Method

Endpoint HTTP Method
https://api.rms.rakuten.co.jp/es/1.0/item/insert 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.itemInsertRequest 商品情報登録要求 XML:itemInsertRequest – ○ 1

 

XML:itemInsertRequest
No Element Description Type Size(byte) Mandatory Multiplicity Note
1 itemInsertRequest.item 商品情報 XML : item – ○ 1

 

XML:item
No Element Description Type Size(byte) Mandatory Multiplicity Note
1 item.itemUrl 商品管理番号 String 255 0,1 設定しない場合は自動発行。
1文字での登録は不可。
ほかの商品と重複不可。
ItemUrlの入力形式：^[0-9a-z\-_]+$
全角・大文字を半角に自動的に変換。
2 item.itemNumber 商品番号 String 32 0,1 可。
全角文字等利用可。
3 item.itemName 商品名 String 255 ○ 1 可。
外部リンク不可。
全半角スペースをtrim
4 item.itemPrice 販売価格 int 4 ○ 1 許容値：0～999999999
「,」「￥」「円」は自動的に削除して登録。
全角を半角に自動的に変換。
5 item.genreId 全商品ディレクトリID int 4 ○ 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.images 商品画像情報リスト – – 0,1 「商品画像情報リスト」内の項目については、「Use Case#商品画像を設定する」を参照してください。
10 item.images.image 商品画像情報 – – 0…n
11 item.images.image.imageUrl 商品画像URL String 255 1 自店舗の楽天GOLD、R-CabinetのURLのみ指定可。
gif/jpg/pngファイルのみ指定可。
入力形式：
https://www.rakuten.ne.jp/gold/[SHOP_URL]
https://image.rakuten.co.jp/[SHOP_URL]/cabinet/
HTMLタグ入力不可。
HTTPSのみ入力可。HTTPは入力不可。
12 item.images.image.imageAlt 商品画像名（ALT） String 255 1 デフォルト値：商品名
HTMLタグ入力不可。
13 item.descriptionForPC PC用商品説明文 String 10240 0,1 スクリプト記述チェック
イベントハンドラー記述チェック
URLにはHTTPSのみ入力可。HTTPは入力不可。
14 item.descriptionForMobile モバイル用商品説明文 String 1024 0,1 スクリプト記述チェック
イベントハンドラー記述チェック
2018年3月30日（金）よりフィーチャーフォン版楽天市場お買い物かご統合に伴い、「モバイル用商品説明文」項目へ入力された値は参照されません※ システム上では「モバイル用商品説明文」項目の値を参照および更新しないことになりますので、値を入れてもエラーにはなりません。ただしこれまで同様、「item.descriptionForMobile」内に改行を含んだ値があるとエラーとなるため、改行を含んだ値を入力しないか、項目を削除してご利用ください。
15 item.descriptionForSmartPhone スマートフォン用商品説明文 String 10240 0,1 スクリプト記述チェック
イベントハンドラー記述チェック
URLにはHTTPSのみ入力可。HTTPは入力不可
16 item.movieUrl 動画URL String 2048 0,1 新動画サービスにて作成されるHTMLソース
HTTPSのみ入力可。HTTPは入力不可。
17 item.options Select/Checkbox用項目情報リスト – – 0,1 「Select/Checkbox用項目情報リスト」内の項目については、「Use Case#項目選択肢を設定する」を参照してください。
18 item.options.option Select/Checkbox用項目情報 – – 0…n
19 item.options.option.optionName Select/Checkbox用項目名 String 255 1 HTMLタグ入力不可
20 item.options.option.optionStyle 選択肢スタイル int 4 1 1：セレクトボックス
2：チェックボックス
21 item.options.option.optionValues Select/Checkbox用選択肢情報リスト – – 1
22 item.options.option.optionValues.optionValue Select/Checkbox用選択肢情報 – – 1…n
23 item.options.option.optionValues.optionValue.value Select/Checkbox用選択肢 String 32 1 HTMLタグ入力不可
24 item.tagIds タグIDリスト – – 0,1
25 item.tagIds.tagId タグID String 183 0…n 許容値：1000000～9999999
全角文字を半角文字に変換するならtrue
IDの値はNavigationAPIの navigation.genre.tag.getをご利用いただくことで、下記の項目から取得可能です。
3.2.10. XML:tag – tagId
26 item.catchCopyForPC PC用キャッチコピー String 174 0,1 外部リンク不可。
Multiline 可。
URLにはHTTPSのみ入力可。HTTPは入力不可。
27 item.catchCopyForMobile モバイル用キャッチコピー String 60 0,1 外部リンク不可。
Multiline 可。
28 item.descriptionBySalesMethod PC用販売説明文 String 10240 0,1 外部リンク不可。
Multiline 可。
URLにはHTTPSのみ入力可。HTTPは入力不可。
29 item.isSaleButton 注文ボタン boolean – 0,1 デフォルト値：true
true：ボタンをつける
false：ボタンをつけない
30 item.isDocumentButton 資料請求ボタン boolean – 0,1 デフォルト値：false
true：ボタンをつける
false：ボタンをつけない
31 item.isInquiryButton 商品問い合わせボタン boolean – 0,1 デフォルト値：true
true：ボタンをつける
false：ボタンをつけない
32 item.isStockNoticeButton 再入荷のお知らせボタン boolean – 0,1 デフォルト値：false
true：ボタンをつける
false：ボタンをつけない
33 item.displayMakerContents メーカー提供コンテンツ表示 boolean – 0,1 デフォルト値：false
true：表示する
false：表示しない
34 item.itemLayout 商品情報レイアウト int 4 0,1 デフォルト値：1
許容値：1～6
1：レイアウトパターンA
2：レイアウトパターンB
3：レイアウトパターンC
4：レイアウトパターンD
5：レイアウトパターンE
6：レイアウトパターンF
35 item.isIncludedTax 消費税 boolean – 0,1 デフォルト値：true
true：消費税込
false：消費税別
36 item.isIncludedPostage 送料 boolean – 0,1 デフォルト値：false
true：送料込
false：送料別
37 item.isIncludedCashOnDeliveryPostage 代引き手数料 boolean – 0,1 デフォルト値：
falsetrue：代引料込
false：代引料別
38 item.displayPrice 表示価格 int 4 0,1 -999：オープン価格
1-999999999：表示価格許容値
全角を半角に自動的に変換。
39 item.orderLimit 注文受付数 int 4 0,1 デフォルト値：-1
許容値：-1～400
全角を半角に自動的に変換。
40 item.postage 個別送料 int 4 0,1 許容値：-1～999999999
全角を半角に自動的に変換。
41 item.postageSegment1 送料区分１ int 4 0,1 許容値：1～15
全角を半角に自動的に変換。
IDの値はShopManagementAPIの shop.shipping.segment.get をご利用いただくことで、下記の項目から取得可能です。
3.2.7.XML:soryoKbn- id
42 item.postageSegment2 送料区分２ int 4 0,1 許容値：1～15
全角を半角に自動的に変換。
IDの値はShopManagementAPIの shop.shipping.segment.get をご利用いただくことで、下記の項目から取得可能です。3.2.7.XML:soryoKbn- id
43 item.isNoshiEnable のし対応 boolean – 0,1 デフォルト値：false
true：対応する
false：対応しない
44 item.isTimeSale 期間限定販売フラグ boolean – 0,1 期間限定販売開始日, 期間限定販売終了日を利用する場合は、
必ず設定してください。設定しない場合、
期間限定販売開始日, 期間限定販売終了日が無効になります。
45 item.timeSaleStartDateTime 期間限定販売開始日 dateTime 32 0,1 YYYY-MM-DDThh:mm:ss+09:00
46 item.timeSaleEndDateTime 期間限定販売終了日 dateTime 32 0,1 YYYY-MM-DDThh:mm:ss+09:00
47 item.isUnavailableForSearch サーチ非表示 boolean – 0,1 デフォルト値：false
false：表示する
true：表示しない
48 item.limitedPasswd 闇市パスワード String 32 0,1
49 item.isAvailableForMobile モバイル表示 boolean – 0,1 デフォルト値：true
true：表示する
false：表示しない
2015年8月6日（木）よりモバイル非表示機能がなくなることにより、「モバイル表示」項目へ入力された値は参照されません。
※システム上では「モバイル表示」項目の値を参照および更新しないことになりますので、値を入れてもエラーにはなりません。
50 item.isDepot 倉庫指定 boolean – 0,1 デフォルト値：false<
true：倉庫に入れる
false：販売中
全角を半角に自動的に変換。
※登録時に商品を公開しない場合は、倉庫指定を”true”に設定してください。
51 item.detailSellType 詳細販売種別 int 4 0,1 デフォルト値：0
許容値：0, 3
0：通常商品
3：予約商品
※予約商品として登録する場合は、detailSellTypeに3（予約商品）を設定し、なおかつreleaseDateに値を設定してください。detailSellTypeに3（予約商品）が設定されている時にreleaseDateに値が設定されていない場合はエラーになります。
※予約商品の登録方法については、2.3.4. Request Sampleをご確認ください。
52 item.releaseDate 予約商品発売日 Date 10 0,1 YYYY-MM-DD※ detailSellTypeを3（予約商品）に設定した場合にのみ有効になります。detailSellTypeに何も設定されていない、もしくは3以外が設定されている場合、releaseDateに値を設定するとエラーになります。
※予約商品の登録方法については、2.3.4. Request Sample をご確認ください。
53 item.point ポイント情報 – – 0,1 「ポイント情報」内の項目については、「Use Case#ポイント変倍情報を設定する」を参照してください。
54 item.point.pointRate ポイント変倍率 int 4 0,1 許容値：2～10
55 item.point.pointRateStart ポイント変倍適応期間（開始） dateTime 32 0,1 YYYY-MM-DDThh:mm:ss+09:00
※mm:ssは”00:00″として自動的に設定される
56 item.point.pointRateEnd ポイント変倍適応期間（終了） dateTime 32 0,1 YYYY-MM-DDThh:mm:ss+09:00
※mm:ssは”59:59″として自動的に設定される
57 item.itemInventory 商品在庫情報 – – 0,1 「商品在庫情報」内の項目については、「Use Case#在庫情報を設定する」を参照してください。
58 item.itemInventory.inventoryType 在庫タイプ（在庫種別） int 4 0,1 許容値：1～2
1：通常在庫設定
2：項目選択肢別在庫設定
全角を半角に自動的に変換。
59 item.itemInventory.inventories 在庫情報リスト – – 0,1
60 item.itemInventory.inventories.inventory 在庫情報 – – 1…n
61 item.itemInventory.inventories.inventory.inventoryCount 在庫数 int 4 1 許容値：0～99999
62 item.itemInventory.inventories.inventory.childNoVertical 項目選択肢別在庫用縦軸選択肢子番号 String 32 0,1 HTMLタグ入力不可。
63 item.itemInventory.inventories.inventory.childNoHorizontal 項目選択肢別在庫用横軸選択肢子番号 String 32 0,1 HTMLタグ入力不可。
64 item.itemInventory.inventories.inventory.optionNameVertical 項目選択肢別在庫用縦軸選択肢 String 32 0,1 可。
65 item.itemInventory.inventories.inventory.optionNameHorizontal 項目選択肢別在庫用横軸選択肢 String 32 0,1 可。
66 item.itemInventory.inventories.inventory.isBackorderAvailable 項目選択肢別在庫用取り寄せ可能表示 boolean – 0,1
67 item.itemInventory.inventories.inventory.normalDeliveryDateId 在庫あり時納期管理番号 String 10 0,1 RMSの納期情報設定で設定した納期管理番号を入力。
IDの値はShopManagementAPIの shop.shipping.deadline.list.get をご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:delvdateMaster – delvdateNumber
68 item.itemInventory.inventories.inventory.backorderDeliveryDateId 在庫切れ時納期管理番号 String 10 0,1 RMSの納期情報設定で設定した納期管理番号を入力。
IDの値はShopManagementAPIの shop.shipping.deadline.list.get をご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:delvdateMaster – delvdateNumber
69 item.itemInventory.inventories.inventory.isBackorder 在庫切れ時の注文受付 boolean – 0,1 デフォルト値：false
true：受け付ける
false：受け付けない
70 item.itemInventory.inventories.inventory.isRestoreInventoryFlag 在庫戻し設定 boolean – 0,1 デフォルト値：false
true：利用する
false：利用しない
71 item.itemInventory.inventories.inventory.images SKU画像情報リスト – – 0,1
72 item.itemInventory.inventories.inventory.images.image SKU画像情報 – – 1…n
73 item.itemInventory.inventories.inventory.images.image.imageUrl SKU画像URL String 255 1 HTTPSのみ入力可。HTTPは入力不可。
74 item.itemInventory.inventories.inventory.tagIds SKUタグIDリスト – – 0,1
75 item.itemInventory.inventories.inventory.tagIds.tagId SKUタグID String 10 1…n 許容値：1000000~9999999
76 item.itemInventory.verticalName 項目選択肢別在庫用縦軸選択肢項目名 String 32 0,1 可。
在庫タイプが2の時使用される項目
77 item.itemInventory.horizontalName 項目選択肢別在庫用横軸選択肢項目名 String 32 0,1 可。
在庫タイプが2の時使用される項目
78 item.itemInventory.inventoryQuantityFlag 在庫数表示 int 4 0,1 在庫タイプが1の時使用される項目
0：残り在庫数表示しない
1：残り在庫数表示する
79 item.itemInventory.inventoryDisplayFlag 項目選択肢別在庫用残り表示閾値 int 4 0,1 デフォルト値：0
許容値：-1～20
在庫タイプが2の時使用される項目
-1：残り在庫数表示する
0：残り在庫数表示しない
1～20：指定の数で△表示
全角を半角に自動的に変換。
80 item.asurakuDeliveryId あす楽配送管理番号 String 10 0,1 デフォルト値：値無し
1より大きい数字：あす楽管理番号がセットされる。
あす楽設定しない場合は、空タグを指定する。
IDの値はShopManagementAPIの shop.shipping.asuraku.get をご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:delvAreaMaster – delvAreaId
81 item.deliverySetId 配送方法セット管理番号 int 4 0,1 デフォルト値:null
0: 配送方法セット管理番号を設定しない or 自動選択配送方法セットを利用する
1以上の数字: 配送方法セット管理番号を設定する
許容値: 1～20
82 item.sizeChartLinkCode サイズ表リンクコード String 5 0,1 サイズ表リンクを利用しない場合は、空タグを指定する。
83 item.reviewDisp レビュー表示 int 4 0,1 デフォルト値：2
0：表示しない
1：表示する
2：RMSのデザイン設定での設定を使用
84 item.medicine 薬事情報 – – ○ 0,1 genreIdに医薬品ジャンルが入力されている場合に必須
※医薬品の取り扱い許可を受けた店舗様のみご利用いただける項目となります。
85 item.medicine.medCaption 医薬品説明文 String 20480 0,1 ※商品登録先の全商品ディレクトリIDが医薬品ジャンルの場合に指定可能です。
URLにはHTTPSのみ入力可。HTTPは入力不可。
86 item.medicine.medAttention 医薬品注意事項 String 20480 0,1 ※商品登録先の全商品ディレクトリIDが医薬品ジャンルの場合に指定可能です。
※第一類医薬品ジャンルおよび指定第二医薬品ジャンルの場合は必須項目となります。
87 item.displayPriceId 二重価格文言ID int 4 0,1 デフォルト値：0
0：自動選択
1：当店通常価格
2：メーカー希望小売価格
4：商品価格ナビのデータ参照
※表示価格設定なしや、オープン価格設定時にも登録可能ですが、その場合商品ページには表示されません。
※ -1は設定できません。設定なしの場合はElementを削除するか0を指定してください。
88 item.categories カテゴリ情報リスト – – 0,1
89 item.categories.categoryInfo カテゴリ情報 – – 0..n
90 item.categories.categoryInfo.categorySetManageNumber カテゴリセット管理番号 String 20 0,1 ※メガショッププランの店舗様のみご利用いただける項目となります。
91 item.categories.categoryInfo.categoryId カテゴリID int 4 0,1 デフォルト値：1
IDの値はCategoryAPI の shop.categories.get をご利用いただくことで、下記の項目から取得可能です。
92 item.categories.categoryInfo.isPluralItemPage 複数表示形式 boolean – 0,1 デフォルト値：false
93 item.itemWeight 表示優先度 int 4 0,1 デフォルト値：999999999
許容値：1～999999999
94 item.layoutCommonId ヘッダー・フッター・レフトナビのテンプレートID int 4 0,1 デフォルト値：0
IDの値はShopManagementAPIの shop.dsgn.navitemplate.list.get をご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:shopLayoutCommon – layoutCommonId
95 item.layoutMapId 表示項目の並び順のテンプレートID int 4 0,1 デフォルト値：0
IDの値はShopManagementAPIの shop.dsgn.itempage.tmpl.list.get をご利用いただくことで、下記の項目から取得可能です。
3.2.7. XML:layoutItemMap – itemMapId
96 item.textSmallId 共通説明文(小)のテンプレートID int 4 0,1 デフォルト値：0
IDの値はShopManagementAPIの shop.dsgn.description.s.list.get をご利用いただくことで、下記の項目から取得可能です。
3.2.7.XML:layoutTextSmall – textSmallId
97 item.lossLeaderId 目玉商品のテンプレートID int 4 0,1 デフォルト値：0
IDの値はShopManagementAPIの shop.dsgn.featured.item.list.get をご利用いただくことで、下記の項目から取得可能です。
XML:layoutLossLeader – lossLeaderId
98 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
1 Content-Type text/xml

 

HTTP Body
XML:result
No Element Description Type Size(byte) Multiplicity Note
1 result.status ステータス XML : status – 1 interfaceId=item.insert
2 result.itemInsertResult 商品情報登録結果 XML : itemInsertResult – 1

 

XML:itemInsertResult
No Element Description Type Size(byte) Multiplicity Note
1 itemInsertResult.code 結果コード String – 1 詳細は、 ItemAPI Response Codes Referenceを参照してください。
2 itemInsertResult.errorMessages エラーメッセージリスト XML : errorMessages – –
3 itemInsertResult.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 4 0,1 List形式の項目についてエラーが発生した際に返却され、エラーが発生したのが何番目のリストかを示す値です。※
5 errorMessage.listIndex2 エラーが発生したリスト内のIndex int 4 0,1 listIndexがあり、かつその対象項目が複数の要素を持つ場合に何番目の要素かを示す値です。※

 

XML:item
No Element Description Type Size(byte) Multiplicity Note
1 item.itemUrl 商品管理番号 String 255 –