RmsItemApi

楽天市場に出店している店舗が使える RMS の商品 API を叩くための ruby ラッパーです。シンプルな CRUD(作成、取得、更新、削除)のみを実装してあります。検索と複数更新は必要があれば追加したいと思います。

Installation

Add this line to your application's Gemfile:

gem 'rms_item_api'

Usage

取得や更新する項目に関しては楽天 RMS WEB API のドキュメント「拡張サービス一覧＞ WEB API サービス＞ RMS WEB SERVICE : ItemAPI」(要ログイン)にて。

Initialize

RMS 内の「拡張サービス一覧＞ WEB API サービス＞利用設定」にある serviceSecret と licenseKey が必要です(事前に WEB API の利用申し込みが必要です)。

client = RmsItemApi::Client.new(
  serviceSecret: "your_serviceSecret",
  licenseKey: "your_licenseKey"
)

Get

RMS に登録している商品情報を商品管理番号を指定して取得することができます。

item = client.get('test123')

# 正常なレスポンスが返ってきているかをtrue/falseで返します
item.is_success?

# 商品名を取得
item.item_name
# 表示価格を取得
item.item_price
# 全ての取得データをhashで出力します
item.all

Insert

RMS に商品情報を登録することができます。

item = client.insert({
  item_url: 'test123',
  item_name: 'api_insert_test_item',
  item_price: '298000',
  genreId: 564040,
  images: {
    image: {
      image_url: 'http://image.rakuten.co.jp/your_shop_id/cabinet/test.jpg'
    }
  },
  item_layout: 2,
  is_included_postage: true
})

# 正常なレスポンスが返ってきているかをtrue/falseで返します
item.is_success?

Update

RMS に登録されている商品情報を更新することができます。

item = client.update({
  item_url: 'test123',
  item_name: 'api_update_test_item',
  item_price: '198000',
  categories: {
    categoryInfo: {
      categoryId: '0000000123'
    }
  }
})

Delete

RMS に登録されている商品情報を削除することができます。

item = client.delete({
  item_url: 'test123',
})