NAME

WebService::Rakuten - Object interface to Rakuten webservice

SYNOPSIS

  use WebService::Rakuten;

  my $rws = WebService::Rakuten->new(
      output_type  => 'perl',
      developer_id => '0123456789abcdef',
  );

  my $result_rh = $rws->itemsearch(
      keyword => 'Sony Vaio',
      page    => 1,
  );

DESCRIPTION

Use this module to conveniently interface with the Rakuten webservices.

Documentation

  http://webservice.rakuten.co.jp/

METHODS

simplehotelsearch

Example

 my $results_rh = $rws->simplehotelsearch(
     largeClassCode  => 'japan',
     middleClassCode => 'akita',
     smallClassCode  => 'tazawa',
 );

Parameters

callBack

type: String

largeClassCode

type: String

middleClassCode

type: String

smallClassCode

type: String

detailClassCode

type: String

hotelNo

type: int(10)

latitude

type: decimal

longitude

type: decimal

searchRadius

type: int
default: 1

squeezeCondition

type: String

carrier

type: int(1)
default: 0

hits

type: long

datumType

type: int(1)
default: 2

Documentation

http://webservice.rakuten.co.jp/simplehotelsearch/

booksgamesearch

Example

 my $results_rh = $rws->booksgamesearch(
     title    => 'バイオハザード',
     hardware => 'Wii',
     sort     => '+itemPrice',
 );

Parameters

callBack

type: String

title

type: String

hardware

type: String

makerCode

type: String

label

type: String

jan

type: long

booksGenreId

type: String
default: 006

hits

type: int
default: 30

page

type: int
default: 1

availability

type: int(1)
default: 0

outOfStockFlag

type: int(1)
default: 0

sort

type: String
default: 'standard'

carrier

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/booksgamesearch/

hoteldetailsearch

Example

 my $results_rh = $rws->hoteldetailsearch( hotelNo => 123456, );

Parameters

callBack

type: String

hotelNo (required)

type: int(10)

carrier

type: int(1)
default: 0

datumType

type: int(1)
default: 2

Documentation

http://webservice.rakuten.co.jp/hoteldetailsearch/

gethotelchainlist

Parameters

callBack

type: String

Documentation

http://webservice.rakuten.co.jp/gethotelchainlist/

bookssoftwaresearch

Example

 my $results_rh = $rws->bookssoftwaresearch(
     title => '会計',
     os    => 'Mac',
     sort  => '+itemPrice',
 );

Parameters

callBack

type: String

title

type: String

os

type: String

makerCode

type: String

label

type: String

jan

type: long

booksGenreId

type: String
default: 004

hits

type: int
default: 30

page

type: int
default: 1

availability

type: int(1)
default: 0

outOfStockFlag

type: int(1)
default: 0

sort

type: String
default: 'standard'

carrier

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/bookssoftwaresearch/

bookscdsearch

Example

 my $results_rh = $rws->bookscdsearch(
     artistName => 'サザンオールスターズ',
     sort       => '+itemPrice',
 );

Parameters

callBack

type: String

title

type: String

artistName

type: String

label

type: String

jan

type: long

booksGenreId

type: String
default: 002

hits

type: int
default: 30

page

type: int
default: 1

availability

type: int(1)
default: 0

outOfStockFlag

type: int(1)
default: 0

sort

type: String
default: 'standard'

carrier

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/bookscdsearch/

vacanthotelsearch

Example

 my $results_rh = $rws->vacanthotelsearch(
     largeClassCode  => 'japan',
     middleClassCode => 'akita',
     smallClassCode  => 'tazawa',
     checkinDate     => '2009-07-01',
     checkoutDate    => '2009-07-02',
     adultNum        => 2,
 );

Parameters

callBack

type: String

largeClassCode

type: String

middleClassCode

type: String

smallClassCode

type: String

detailClassCode

type: String

hotelNo

type: int(10)

checkinDate (required)

type: date

checkoutDate (required)

type: date

adultNum

type: int(2)
default: 1

upClassNum

type: int(2)
default: 0

lowClassNum

type: int(2)
default: 0

infantWithMBNum

type: int(2)
default: 0

infantWithMNum

type: int(2)
default: 0

infantWithBNum

type: int(2)
default: 0

infantWithoutMBNum

type: int(2)
default: 0

roomNum

type: int(3)
default: 1

maxCharge

type: long

minCharge

type: long

latitude

type: decimal

longitude

type: decimal

searchRadius

type: int
default: 1

squeezeCondition

type: String

carrier

type: int(1)
default: 0

datumType

type: int(1)
default: 2

Documentation

http://webservice.rakuten.co.jp/vacanthotelsearch/

booksmagazinesearch

Example

 my $results_rh = $rws->booksmagazinesearch(
     title        => '週間 経済',
     booksGenreId => 007604001,
     sort         => '+itemPrice',
 );

Parameters

callBack

type: String

title

type: String

publisherName

type: String

jan

type: long

booksGenreId

type: String
default: 007

hits

type: int
default: 30

page

type: int
default: 1

availability

type: int(1)
default: 0

outOfStockFlag

type: int(1)
default: 0

sort

type: String
default: 'standard'

carrier

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/booksmagazinesearch/

itemcodesearch

Example

 my $results_rh = $rws->itemcodesearch( itemCode => 'aaa:1234567', );

Parameters

itemCode (required)

type: String

Documentation

http://webservice.rakuten.co.jp/itemcodesearch/

bookstotalsearch

Example

 my $results_rh = $rws->bookstotalsearch(
     keyword   => 'ガンダム',
     NGKeyword => '予約',
     sort      => '+itemPrice',
 );

Parameters

callBack

type: String

keyword

type: String

booksGenreId

type: String
default: 000

hits

type: int
default: 30

page

type: int
default: 1

availability

type: int(1)
default: 0

outOfStockFlag

type: int(1)
default: 0

sort

type: String
default: 'standard'

field

type: int(1)
default: 1

carrier

type: int(1)
default: 0

orFlag

type: int(1)
default: 0

NGKeyword

type: String

Documentation

http://webservice.rakuten.co.jp/bookstotalsearch/

booksforeignbooksearch

Example

 my $results_rh = $rws->booksforeignbooksearch(
     title        => 'HarryPotter',
     booksGenreId => 005407,
     sort         => '+itemPrice',
 );

Parameters

callBack

type: String

title

type: String

author

type: String

publisherName

type: String

isbn

type: long

booksGenreId

type: String
default: 005

hits

type: int
default: 30

page

type: int
default: 1

availability

type: int(1)
default: 0

outOfStockFlag

type: int(1)
default: 0

sort

type: String
default: 'standard'

carrier

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/booksforeignbooksearch/

genresearch

Example

 my $results_rh = $rws->genresearch( genreId => 0, );

Parameters

genreId (required)

type: int

Documentation

http://webservice.rakuten.co.jp/genresearch/

auctionitemsearch

Example

 my $results_rh = $rws->auctionitemsearch(
     keyword => '福袋',
     sort    => '+bidCount',
 );

Parameters

callBack

type: String

keyword

type: String

genreId

type: long

hits

type: int
default: 30

page

type: int
default: 1

minPrice

type: long

maxPrice

type: long

sort

type: String
default: '+endTime'

blowFlag

type: int(1)
default: 0

itemType

type: int(1)
default: 0

newFlag

type: int(1)
default: 0

field

type: int(1)
default: 1

carrier

type: int(1)
default: 0

imageFlag

type: int(1)
default: 0

orFlag

type: int(1)
default: 0

NGKeyword

type: String

Documentation

http://webservice.rakuten.co.jp/auctionitemsearch/

dynamicad

Example

 my $results_rh =
   $rws->dynamicad( url =>
 'http%3a%2f%2fplaza%2erakuten%2eco%2ejp%2fisblog%2fdiary%2f200705230001%2f',
   );

Parameters

url

type: String

carrier

type: int
default: 0

callBack

type: String

Documentation

http://webservice.rakuten.co.jp/dynamicad/

cdsearch

Example

 my $results_rh = $rws->cdsearch(
     keyword => 'SMAP',
     genreId => 200533,
     sort    => '+itemPrice',
 );

Parameters

callBack

type: String

keyword

type: String

genreId

type: long
default: 0

hits

type: int
default: 30

page

type: int
default: 1

sort

type: String
default: '-reviewCount'

minPrice

type: long

maxPrice

type: long

availability

type: int(1)
default: 1

field

type: int(1)
default: 1

carrier

type: int(1)
default: 0

imageFlag

type: int(1)
default: 0

orFlag

type: int(1)
default: 0

NGKeyword

type: String

genreInformationFlag

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/cdsearch/

booksearch

Example

 my $results_rh = $rws->booksearch(
     keyword => 'ブログ',
     genreId => 200446,
     sort    => '+itemPrice',
 );

Parameters

callBack

type: String

keyword

type: String

genreId

type: long
default: 0

hits

type: int
default: 30

page

type: int
default: 1

sort

type: String
default: '-reviewCount'

minPrice

type: long

maxPrice

type: long

availability

type: int(1)
default: 1

field

type: int(1)
default: 1

carrier

type: int(1)
default: 0

imageFlag

type: int(1)
default: 0

orFlag

type: int(1)
default: 0

NGKeyword

type: String

genreInformationFlag

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/booksearch/

getareaclass

Parameters

callBack

type: String

Documentation

http://webservice.rakuten.co.jp/getareaclass/

hotelranking

Example

 my $results_rh = $rws->hotelranking( genre => 'all', );

Parameters

callBack

type: String

genre (required)

type: String
default: 'all'

carrier

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/hotelranking/

catalogsearch

Example

 my $results_rh = $rws->catalogsearch(
     keyword => '%e6%b6%b2%e6�%b6%e3��%e3�%ac%e3��',
     sort    => '-reviewCount',
 );

Parameters

callBack

type: String

keyword

type: String

genreId

type: long
default: 0

hits

type: int
default: 30

page

type: int
default: 1

sort

type: String
default: '-registerDate'

field

type: int(1)
default: 1

imageFlag

type: int(1)
default: 0

releaseRange

type: int
default: 0

orFlag

type: int(1)
default: 0

NGKeyword

type: String

genreInformationFlag

type: String
default: 0

Documentation

http://webservice.rakuten.co.jp/catalogsearch/

booksdvdsearch

Example

 my $results_rh = $rws->booksdvdsearch(
     title => 'ガンダム',
     sort  => '+itemPrice',
 );

Parameters

callBack

type: String

title

type: String

artistName

type: String

label

type: String

jan

type: long

booksGenreId

type: String
default: 003

hits

type: int
default: 30

page

type: int
default: 1

availability

type: int(1)
default: 0

outOfStockFlag

type: int(1)
default: 0

sort

type: String
default: 'standard'

carrier

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/booksdvdsearch/

keywordhotelsearch

Example

 my $results_rh = $rws->keywordhotelsearch( keyword => '伊豆', );

Parameters

callBack

type: String

carrier

type: int(1)
default: 0

page

type: int
default: 1

hits

type: int
default: 20

sumDisplayFlag

type: int(1)
default: 0

keyword (required)

type: String

middleClassCode

type: String

Documentation

http://webservice.rakuten.co.jp/keywordhotelsearch/

itemranking

Parameters

callBack

type: String

genreId

type: long

age

type: int

sex

type: int

Documentation

http://webservice.rakuten.co.jp/itemranking/

auctionitemcodesearch

Example

 my $results_rh = $rws->auctionitemcodesearch( itemCode => 'i:aaa:1234567', );

Parameters

callBack

type: String

itemCode (required)

type: String

carrier

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/auctionitemcodesearch/

dvdsearch

Example

 my $results_rh = $rws->dvdsearch(
     keyword => 'SMAP',
     genreId => 300337,
     sort    => '+itemPrice',
 );

Parameters

callBack

type: String

keyword

type: String

genreId

type: long
default: 0

hits

type: int
default: 30

page

type: int
default: 1

sort

type: String
default: '-reviewCount'

minPrice

type: long

maxPrice

type: long

availability

type: int(1)
default: 1

field

type: int(1)
default: 1

carrier

type: int(1)
default: 0

imageFlag

type: int(1)
default: 0

orFlag

type: int(1)
default: 0

NGKeyword

type: String

genreInformationFlag

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/dvdsearch/

itemsearch

Example

 my $results_rh = $rws->itemsearch(
     keyword => '福袋',
     sort    => '+itemPrice',
 );

Parameters

callBack

type: String

keyword

type: String

shopCode

type: String

genreId

type: long
default: 0

catalogCode

type: String

hits

type: int
default: 30

page

type: int
default: 1

sort

type: String
default: 'standard'

minPrice

type: long

maxPrice

type: long

availability

type: int(1)
default: 1

field

type: int(1)
default: 1

carrier

type: int(1)
default: 0

imageFlag

type: int(1)
default: 0

orFlag

type: int(1)
default: 0

NGKeyword

type: String

genreInformationFlag

type: int(1)
default: 0

purchaseType

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/itemsearch/

booksbooksearch

Example

 my $results_rh = $rws->booksbooksearch(
     title        => '太陽',
     booksGenreId => 001004008,
     sort         => '+itemPrice',
 );

Parameters

callBack

type: String

title

type: String

author

type: String

publisherName

type: String

size

type: int
default: 0

isbn

type: long

booksGenreId

type: String
default: 001

hits

type: int
default: 30

page

type: int
default: 1

availability

type: int(1)
default: 0

outOfStockFlag

type: int(1)
default: 0

sort

type: String
default: 'standard'

carrier

type: int(1)
default: 0

Documentation

http://webservice.rakuten.co.jp/booksbooksearch/

booksgenresearch

Example

 my $results_rh = $rws->booksgenresearch( booksGenreId => 000, );

Parameters

booksGenreId (required)

type: String

Documentation

http://webservice.rakuten.co.jp/booksgenresearch/

LIMITATIONS

Namespace

There are multiple authors with permission on this namespace. If you're installing via the cpan prompt, or command line tool, you'll need to do so like this:

 cpan[1]> install DYLAN/WebService-Rakuten-0.05.tar.gz

Auto-generated code

This module and its POD were generated by a program which crawls the online documentation and outputs a Perl interpretation. I may never personally test every function. Please report any bugs.

Method documentation links

For reasons beyond this author's control, Rakuten doesn't want you to follow links from other websites to their API pages. They enforce this by redirecting you to the main API page whenever you follow any of the above links. Go figure.

AUTHOR

Dylan Doxey, <dylan.doxey@gmail.com>

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.