楽天市場API:出品商品情報の取得
目次
出品中の商品情報を取得するAPI
RMSに登録している商品情報を取得することができます。
殆どが出品の際に作成した情報であるため、主な用途はバックアップとなりますが、編集ロックされたジャンルコードの確認などにも利用できます。
APIメソッド:item.get
※2020/03/17 送料設定系追加カラム追加登録しました。
この機能を利用すると、RMSに登録している商品情報を「商品管理番号」を指定して取得することができます。
Endpoint / HTTP Method
Endpoint | HTTP Method |
---|---|
https://api.rms.rakuten.co.jp/es/1.0/item/get | GET |
Request
HTTP Header
No | Key | Value | Note |
---|---|---|---|
1 | Authorization | ESA Base64(serviceSecret:licenseKey) |
Query parameters
No | Parameter | Description | Type | Mandatory | Multiplicity | Note |
---|---|---|---|---|---|---|
1 | itemUrl | 商品管理番号 | String | ○ | 1 | 商品管理番号を1件のみ指定可能 |
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.get |
2 | result.itemGetResult | 商品情報取得結果 | XML:itemGetResult | – | 1 |
XML:itemGetResult
No | Element | Description | Type | Size(byte) | Multiplicity | Note |
---|---|---|---|---|---|---|
1 | itemGetResult.code | 結果コード | String | 4byte | 1 | 詳細は、 ItemAPI Response Codes Referenceを参照してください。 |
2 | itemGetResult.item | 商品情報 | XML:item | – | 1 |
XML:item
No | Element | Description | Type | Size(byte) | Multiplicity | Note |
---|---|---|---|---|---|---|
1 | item.itemUrl | 商品管理番号 | String | 255 | 1 | ItemUrlの形式:^[0-9a-z\-_]+$ |
2 | item.itemNumber | 商品番号 | String | 32 | 1 | |
3 | item.itemName | 商品名 | String | 255 | 1 | |
4 | item.itemPrice | 販売価格 | int | 4 | 1 | |
5 | item.genreId | 全商品ディレクトリID | int | 4 | 1 | 許容値:100000~999999 |
6 | item.catalogId | カタログID | String | 30 | 1 | |
7 | item.catalogIdExemptionReason | カタログIDなしの理由 | int | 4 | 1 | |
8 | item.whiteBgImageUrl | 白背景画像URL | String | 255 | 0,1 | |
9 | item.images | 商品画像情報リスト | – | – | 1 | 「商品画像情報リスト」内の項目については、「Use Case#商品画像を設定する」を参照してください。 |
10 | item.images.image | 商品画像情報 | – | – | 0…n | |
11 | item.images.image.imageUrl | 商品画像URL | String | 255 | 1 | |
12 | item.images.image.imageAlt | 商品画像名(ALT) | String | 255 | 1 | |
13 | item.descriptionForPC | PC用商品説明文 | String | 10240 | 1 | |
14 | item.descriptionForSmartPhone | スマートフォン用商品説明文 | String | 10240 | 1 | |
15 | item.movieUrl | 動画URL | String | 2048 | 1 | |
16 | item.options | Select/Checkbox用項目情報リスト | – | – | 1 | 「Select/Checkbox用項目情報リスト」内の項目については、「Use Case#項目選択肢を設定する」を参照してください。 |
17 | item.options.option | Select/Checkbox用項目情報 | – | – | 0…n | |
18 | item.options.option.optionName | Select/Checkbox用項目名 | String | 255 | 1 | |
19 | item.options.option.optionStyle | 選択肢スタイル | int | 4 | 1 | 1:セレクトボックス 2:チェックボックス |
20 | item.options.option.isOptionRequired | 選択必須 | boolean | – | – | デフォルト値:false true:選択必須とする false:選択必須としない |
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 | |
24 | item.tagIds | タグIDリスト | – | – | 1 | |
25 | item.tagIds.tagId | タグID | String | 183 | 0…n | |
26 | item.catchCopyForPC | PC用キャッチコピー | String | 174 | 1 | |
27 | item.catchCopyForMobile | モバイル用キャッチコピー | String | 60 | 1 | |
28 | item.descriptionBySalesMethod | PC用販売説明文 | String | 10240 | 1 | |
29 | item.isSaleButton | 注文ボタン | boolean | – | 1 | true:ボタンをつける false:ボタンをつけない |
30 | item.isDocumentButton | 資料請求ボタン | boolean | – | 1 | true:ボタンをつける false:ボタンをつけない |
31 | item.isInquiryButton | 商品問い合わせボタン | boolean | – | 1 | true:ボタンをつける false:ボタンをつけない |
32 | item.isStockNoticeButton | 再入荷のお知らせボタン | boolean | – | 1 | true:ボタンをつける false:ボタンをつけない |
33 | item.displayMakerContents | メーカー提供コンテンツ表示 | boolean | – | 0,1 | デフォルト値:false true:表示する false:表示しない |
34 | item.itemLayout | 商品情報レイアウト | int | 4 | 1 | 1:レイアウトパターンA 2:レイアウトパターンB 3:レイアウトパターンC 4:レイアウトパターンD 5:レイアウトパターンE 6:レイアウトパターンF |
35 | item.isIncludedTax | 消費税 | boolean | – | 1 | true:消費税込 false:消費税別 |
36 | item.isIncludedPostage | 送料 | boolean | – | 1 | true:送料込 false:送料別 |
37 | item.isIncludedCashOnDeliveryPostage | 代引き手数料 | boolean | – | 1 | true:代引料込 false:代引料別 |
38 | item.displayPrice | 表示価格 | int | 4 | 0,1 | -999:オープン価格 1-999999999:表示価格許容値 |
39 | item.orderLimit | 注文受付数 | int | 4 | 1 | |
40 | item.postage | 個別送料 | int | 4 | 1 | |
41 | item.postageSegment1 | 送料区分1 | int | 4 | 0,1 | 送料区分1設定時は区分番号(1~15)が表示 |
42 | item.postageSegment2 | 送料区分2 | int | 4 | 0,1 | 送料区分2設定時は区分番号(1~15)が表示 |
43 | item.isNoshiEnable | のし対応 | boolean | – | 1 | true:対応する false:対応しない |
44 | item.isTimeSale | 期間限定販売フラグ | boolean | – | 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 | – | 1 | true:表示しない false:表示する |
48 | item.limitedPasswd | 闇市パスワード | String | 32 | 0,1 | |
49 | item.isDepot | 倉庫指定 | boolean | – | 1 | true:倉庫に入れる false:販売中 |
50 | item.detailSellType | 詳細販売種別 | int | 4 | 0,1 | 0:通常商品 3:予約商品 ※0と3しか返却されません。 |
51 | item.releaseDate | 予約商品発売日 | Date | 10 | 0,1 | 予約商品の場合のみ表示 YYYY-MM-DD |
52 | item.point | ポイント情報 | – | – | 1 | 「ポイント情報」内の項目については、「Use Case#ポイント変倍情報を設定する」を参照してください。 |
53 | item.point.pointRate | ポイント変倍率 | int | 4 | 1 | 許容値:2~10 |
54 | item.point.pointRateStart | ポイント変倍適応期間(開始) | dateTime | 32 | 1 | YYYY-MM-DDThh:mm:ss+09:00 |
55 | item.point.pointRateEnd | ポイント変倍適応期間(終了) | dateTime | 32 | 1 | YYYY-MM-DDThh:mm:ss+09:00 |
56 | item.itemInventory | 商品在庫情報 | – | – | 1 | 「商品在庫情報」内の項目については、「Use Case#在庫情報を設定する」を参照してください。 |
57 | item.itemInventory.inventoryType | 在庫タイプ(在庫種別) | int | 4 | 1 | 0:在庫設定しない 1:通常在庫設定 2:項目選択肢別在庫設定 |
58 | item.itemInventory.inventories | 在庫情報リスト | – | – | 0,1 | |
59 | item.itemInventory.inventories.inventory | 在庫情報 | – | – | 1…n | |
60 | item.itemInventory.inventories.inventory.inventoryCount | 在庫数 | int | 4 | 1 | 許容値:0~999999999 |
61 | item.itemInventory.inventories.inventory.childNoVertical | 項目選択肢別在庫用縦軸選択肢子番号 | String | 32 | 1 | |
62 | item.itemInventory.inventories.inventory.childNoHorizontal | 項目選択肢別在庫用横軸選択肢子番号 | String | 32 | 1 | |
63 | item.itemInventory.inventories.inventory.optionNameVertical | 項目選択肢別在庫用縦軸選択肢 | String | 32 | 1 | |
64 | item.itemInventory.inventories.inventory.optionNameHorizontal | 項目選択肢別在庫用横軸選択肢 | String | 32 | 1 | |
65 | item.itemInventory.inventories.inventory.isBackorderAvailable | 項目選択肢別在庫用取り寄せ可能表示 | boolean | – | 1 | |
66 | item.itemInventory.inventories.inventory.normalDeliveryDateId | 在庫あり時納期管理番号 | String | 10 | 1 | |
67 | item.itemInventory.inventories.inventory.backorderDeliveryDateId | 在庫切れ時納期管理番号 | String | 10 | 1 | |
68 | item.itemInventory.inventories.inventory.isBackorder | 在庫切れ時の注文受付 | boolean | – | 1 | true:受け付ける false:受け付けない |
69 | item.itemInventory.inventories.inventory.isRestoreInventoryFlag | 在庫戻し設定 | boolean | – | 1 | true:利用する false:利用しない |
70 | item.itemInventory.inventories.inventory.images | SKU画像情報リスト | – | – | 0,1 | |
71 | item.itemInventory.inventories.inventory.images.image | SKU画像情報 | – | – | 1…n | |
72 | item.itemInventory.inventories.inventory.images.image.imageUrl | SKU画像URL | String | 255 | 1 | |
73 | item.itemInventory.inventories.inventory.tagIds | SKUタグIDリスト | – | – | 0,1 | |
74 | item.itemInventory.inventories.inventory.tagIds.tagId | SKUタグID | String | 10 | 1…n | 許容値:1000000~9999999 |
75 | item.itemInventory.verticalName | 項目選択肢別在庫用縦軸選択肢項目名 | String | 32 | 0,1 | 在庫タイプが2の時使用される項目 |
76 | item.itemInventory.horizontalName | 項目選択肢別在庫用横軸選択肢項目名 | String | 32 | 0,1 | 在庫タイプが2の時使用される項目 |
77 | item.itemInventory.inventoryQuantityFlag | 在庫数表示 | int | 4 | 1 | 在庫タイプが1の時使用される項目 0:残り在庫数表示しない 1:残り在庫数表示する |
78 | item.itemInventory.inventoryDisplayFlag | 項目選択肢別在庫用残り表示閾値 | int | 4 | 0,1 | 在庫タイプが2の時使用される項目 -1:残り在庫数表示する 0:残り在庫数表示しない 1~20:指定の数で△表示 |
79 | item.asurakuDeliveryId | あす楽配送管理番号 | String | 10 | 1 | 1より大きい数字:あす楽管理番号がセットされる ※あす楽設定しない場合、当該要素は省略されます。 |
80 | item.deliverySetId | 配送方法セット管理番号 | int | 4 | 1 | 0: 配送方法セット管理番号を設定しない or 自動選択配送方法セットを利用する 1以上の数字: 配送方法セット管理番号を設定する |
81 | item.sizeChartLinkCode | サイズ表リンクコード | String | 5 | 1 | サイズ表リンクを利用しない場合、当該要素は省略されます。 |
82 | item.reviewDisp | レビュー表示 | int | 4 | 1 | 0:表示しない 1:表示する 2:RMSのデザイン設定での設定を使用 |
83 | item.medicine | 薬事情報 | – | – | 0,1 | ※医薬品の取り扱い許可を受けた店舗様のみご利用いただける項目となります。 |
84 | item.medicine.medCaption | 医薬品説明文 | String | 20480 | 1 | |
85 | item.medicine.medAttention | 医薬品注意事項 | String | 20480 | 1 | |
86 | item.displayPriceId | 二重価格文言ID | int | 4 | 1 | -1:設定なし 0:自動選択 1:当店通常価格 2:メーカー希望小売価格 4:商品価格ナビのデータ参照 |
87 | item.categories | カテゴリ情報リスト | – | – | 1 | |
88 | item.categories.categoryInfo | カテゴリ情報 | – | – | 1..n | |
89 | item.categories.categoryInfo.categorySetManageNumber | カテゴリセット管理番号 | String | 20 | 0,1 | ※ メガショッププランの店舗様のみご利用いただける項目となります。 |
90 | item.categories.categoryInfo.categoryId | カテゴリID | int | 4 | 1 | |
91 | item.categories.categoryInfo.isPluralItemPage | 複数表示形式 | boolean | – | 1 | |
92 | item.itemWeight | 表示優先度 | int | 4 | 1 | 許容値:1~999999999 |
93 | item.layoutCommonId | ヘッダー・フッター・レフトナビのテンプレートID | int | 4 | 1 | |
94 | item.layoutMapId | 表示項目の並び順のテンプレートID | int | 4 | 1 | |
95 | item.textSmallId | 共通説明文(小)のテンプレートID | int | 4 | 1 | |
96 | item.lossLeaderId | 目玉商品のテンプレートID | int | 4 | 1 | |
97 | item.textLargeId | 共通説明文(大)のテンプレートID | int | 4 | 1 | |
98 | item.shopAreaSoryoPatternId | 地域別個別送料管理番号 | int | 4 | 0,1 | 0:地域別個別送料管理番号を設定しない 1以上の数字:地域別個別送料管理番号(許容値:1から20) |
99 | item.taxRate | 消費税率 | double | 64 | 0,1 | 以下のいずれか ・0:税率が 0% ・0.08:税率が 8% ・0.1:税率が 10% 商品の税率が未設定の場合、該当項目が存在しない。 |
100 | item.isSingleItemShipping | 単品配送設定 | boolean | 4 | 1 | デフォルト値:false false:設定なし true:設定あり |
101 | item.singleItemShippingReason | 単品配送設定使用理由 | int | 4 | 0,1 | 1:産地直送の商品 2:メーカー直送の商品 3:ケース売りの商品 4:長尺・異形の商品 5:出荷地が異なる商品 6:温度帯が異なる商品 0:値を削除 ※「単品配送設定」が「設定あり」の場合「単品配送設定使用理由」は入力必須 |
-
前の記事
楽天市場API:楽天プロダクト情報取得 2018.08.30
-
次の記事
楽天市場API:商品を出品する 2018.08.30
コメントを残す