日別アーカイブ: 2018年10月23日

楽天API 楽天ペイで受注情報の取得についてメモ

< 目的 >

特定の注文詳細データを取得する。
ex)ステータスが「発送待ち」となっている受注分から商品名(IDや管理番号なども)を取得したい
ex)ある一定期間内で「あす楽」の受注件数を取得したい

 

< 必要なもの >

・店舗URL
・serviceSecret
・licenseKey

 

< 手順概要 >

認証キー(AuthKey)の作成
リクエストパラメータをJSON で作成
エンドポイントにリクエストを投げる
レスポンスもJSONなので望むように処理

 

< 詳細 >

まずはserchOrderを使って受注番号を取得する。
デフォルトでは30件しか取得できないので、下記でリクエスト用のクラスにて件数を最大の1000件に変更。

認証キーの作成

 

リクエストパラメータをJSONで作成
パラメータは別途パラメータ設定用のクラスを用意。日付はUI上にデータピッカーをおいて設定。

尚、パラメータは下記のようなイメージでクラスを用意しておく。

 

エンドポイントにリクエストを投げる

 

受け取った結果もJSONなので、今回はデシリアライズしてオブジェクトにする。

デシリアライズのためには下記のようなクラスを用意。

 

SearchOrderResponseクラスのorderNumberListに最大1000件分の受注番号が取得できるので、次はその受注番号を使って受注情報を取得する。

受注情報の取得も基本的な手順は同じなので、「認証キー(AuthKey)の作成」「リクエストパラメータをJSON で作成」「エンドポイントにリクエストを投げる」「レスポンスもJSONなので望むように処理」で作業を行う。

尚、受注情報の取得にはgetOrderを利用するが、serchOrderは最大1000件の受注番号リストを取得できるのに対して、100件までとなっているので、対象の受注番号を絞り込む必要も出てくるかと。