楽天ペイAPI連携の連携方法

楽天ペイAPI連携の連携方法

1.概要

本ページでは楽天ペイAPIの運用に関する設定手順をご案内します。

楽天ペイを利用する際には、必ず以下の注意事項と設定手順をご確認ください。

楽天ペイAPI連携で行えること

  • 受注の自動取込
  • 受注情報の更新
  • 楽天ペイ注文に対する注文確認
  • 荷物番号の反映
  • 受注情報のキャンセル
  • 出荷後の受注情報更新

楽天ペイAPI連携で行えないこと

以下の項目はTEMPOSTARから楽天ペイへ連携できないため、直接RMS上で操作する必要があります。

  • サブステータス更新

楽天ペイAPIで更新できる項目

楽天ペイAPIを利用することで、TEMPOSTARで修正した情報を楽天RMS上の受注データへ自動反映させることが可能です。
情報の反映が可能な項目は以下のとおりです。

  • [ 受注情報 ] – [ 楽天減額理由 ]
    ※配送料、決済手数料、単価等がRMSに登録されている金額から減額されている場合に反映
  • [ 配送先情報 ] – [ 配送料 ]
  • [ 配送先情報 ] – [ 決済手数料 ]
  • [ 商品情報 ] – [ 数量 ]
  • [ 商品情報 ] – [ 単価 ]
    ※TEMPOSTAR設定>消費税計算方式設定>楽天列が「税別」の場合は[ 税別単価 ]、
     「税込」の場合は[ 税込単価 ]を反映
  • [ 商品情報 ] – [ 消費税 ]
    ※TEMPOSTAR設定>消費税計算方式設定>楽天列が「税別」の場合のみ反映

荷物番号報告時に楽天RMSへ反映できる項目

以下の項目は、出荷確定インポート後に自動反映される項目です。
なお TEMPOSTAR受注進捗「出荷済」>「R荷物」 ボタンから手動でAPI反映もしくはCSV登録することも可能です。

  • [ 配送先情報 ] – [ 荷物番号 ]
  • [ 配送先情報 ] – [ 配送方法 ]
    ※設定>配送業者設定 にて「配送方法」に対して設定されている配送業者情報
  • [ 配送先情報 ] – [ 配送日 ]
    ※TEMPOSTAR設定>楽天市場設定>楽天ペイAPI設定>荷物番号反映時時設定
     にて設定した「配送日」に反映する項目の日付を反映

楽天受注API連携利用における注意点

  • TEMPOSTARと楽天ペイAPIを連携する際には、費用は一切掛かりません。
  • 楽天ペイを利用する場合は、事前に楽天RMSが楽天ペイ仕様に切り替えられている必要があります。
    楽天ペイへの切替が済んでいない場合は楽天市場サポートセンターへお問い合わせください。
  • 金額修正等を行う場合は、基本的に楽天RMSでは操作せずTEMPOSTAR上から行なってください。
  • RMS からの受注データ情報取得は初回取込時の1回のみです。
    受注情報の再取込を行いたい場合やエラーなどで取込漏れが発生した際は受注CSVにて取り込んでください。
  • 「全ポイント利用」の場合、受注データの金額修正が行なわれるとRMS上で利用ポイントの再計算が行なわれます。
    ただし前述の通り、RMS からの受注データ情報取得は初回以降行なわれません。
    利用ポイントの再計算によりポイント利用額が変動した場合は、TEMPOSTAR上のポイント利用額を手修正してください。
  • 手動登録した受注情報に対して楽天受注APIの機能を利用することはできません。
    受注API、もしくは受注CSVにて取り込んだ受注情報のみ連携できます。
  • 受注APIの反映には最短で20分ほどのタイムラグが発生します。
  • 商品情報を追加・削除した情報を楽天市場へ連携することはできません。

2.楽天RMSで行う事前準備

楽天RMSにて、楽天ペイAPIを利用する準備を行います。

受注API認証キー発行方法

楽天ペイAPIのライセンス情報は、弊社へ利用申請を行った上で楽天RMSから発行手続きを行います。

(1) 下記FAQを参考に弊社宛利用申請を行います。
>>楽天市場_API連携のお申し込み方法はこちら

(2) 申請後、楽天市場から届く確認メールに記載されているURLから、
API利用に関して「同意」し、認証キー発行を行います。
※楽天市場の確認メールから認証キー発行に関する詳細は下記マニュアルからご確認いただけますが、RMSの操作に関する問い合わせは楽天RMSサポートセンターにお問い合わせください。
>>詳しくはこちら

既に楽天ペイ切替前から楽天受注APIを利用していて、上記の申請が完了している場合は、
下記より楽天ペイAPIが利用可能な状態かどうかを確認してください。
>>詳しくはこちら

利用可能な状態であれば、3.TEMPOSTARでの事前設定 > 手順4 に進んでください。

3.TEMPOSTARで行う初期設定

TEMPOSTAR「設定」より、楽天ペイAPIを利用するための設定をします。

(1) TEMPOSTARの「設定>共通設定>連携ショップ基本設定」から、楽天のショップ名をクリックします。

(2) 「▼楽天API連携設定(在庫)(受注)」にて、以下の情報を入力します。
・店舗URL:
「2.楽天RMSで行う事前準備」>受注API認証キー発行方法にて確認した「店舗URL」(※店舗IDの部分のみ)
・licenseKey:
「2.楽天RMSで行う事前準備」>受注API認証キー発行方法にて発行した「licenseKey」

(3) 設定後、「接続確認」を押して正常にログインができたことを確認し、更新します。

(4) TEMPOSTARの「設定>受注管理設定(連携)>楽天市場設定(楽天ペイAPI設定)」を設定します。

設定内容の詳細については、下記をご覧ください。
>>詳しくはこちら

4.楽天ペイAPIの運用方法