Skip to main content

​
Intro

Rakuten Merchant Server (RMS) is a system that integrates four functions (store construction, order management, email distribution, and data analysis) that are essential for smooth store operations and user interaction. The Domo’s Rakuten Merchant Server Connector allows you to use order information on Domo. For more information on the RMS API, refer to https://webservice.rms.rakuten.co.jp/merchant-portal/backToMenu. Use of the RMS API is subject to the RMS API Terms of Service, and use of the API constitutes acceptance of the API Terms of Service. You connect to your RMS account in the Data Center. This topic discusses the fields and menus that are specific to the Amazon DynamoDB connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.

​
Prerequisites

To connect to your RMS account and create a DataSet, you must have the following::
  1. The serviceSecret and licenseKey for your RMS Account. To find your API Key, see Steps for using RMS APIs.
  2. Set each of the following APIs to the status of in use on the RMS APIs:
Refer to https://webservice.rms.rakuten.co.jp/merchant-portal/configurationApi for more details. 
  • APIs：LicenseManagementAPI: license.expiryDate.get, 

  • PurchaseItemAPI: purchaseitem.searchOrderItem, purchaseitem.getOrderItem,

  • RakutenPay_OrderAPI: rpay.order.searchOrder, rpay.order.getOrder

​
Connecting to Your RMS Account

This section enumerates the options in the Credentials and Details panes in the RMS Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

​
Credentials Pane

This pane contains fields for entering credentials to connect to your RMS account. The following table describes what is needed for each field:

Field

Description

serviceSecret

Enter your RMS serviceSecret.

licenseKey

Enter your RMS licenseKey.

For information about obtaining these credentials, see Prerequisites above. Once you have entered valid RMS credentials, you can use the same account any time you go to create a new RMS DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.

​
Details Pane

This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.

Menu

Description

Report

Select the report you want to run. The following reports are available:

Purchase Item Returns the accessible order information in your account.
Item Model Returns the accessible information of product order in your account.
Rakuten Pay Order Returns the accessible order information paid by Rakuten Pay in your account.
Rakuten Pay Order without PII Returns the accessible order information (except personal identification information) paid by Rakuten Pay in your account.
Rakuten Pay Order Item Model Returns the accessible information of product order paid by Rakuten Pay in your account.

Updated

Select in Date selection whether a single day or a date range when filter the result by update date of items.

Single date Select the specific or relative single date.
Date range Select the specific or relative date range.
Time period Select the time period from Time period dropdown for your report.

Updated - Date

Select in Date Type from the followings whether the report data is for a specific date or for a relative number of days back from today.

Relative Enter the number of days back that you would like to get data for in the Days Back field. Specify either today or 0, yesterday or 1, or today-7 or 7 to get data for 7 days into the past.
Specific Select the specific date using the date selector in the Date field.
Updated - Start Date Select in Date Type from the followings:
Relative Enter the number of days back that you would like to get data from (start day). Combine with End Date to create a range of represented days.
For example, if you entered 10 for Start Date and 5 for End Date , the report would contain data for 10 days ago up until 5 days ago.
Specific Select the first date in your date range using the date selector.
Updated - End Date

Select in Date Type from the followings:

Relative Enter the number of days back that you would like to get data to (end day). Combine with Start Date to create a range of represented days.
For example, if you entered 10 for Start Date and 5 for End Date , the report would contain data for 10 days ago up until 5 days ago.
Specific Select the last date in your date range using the date selector.
Updated - Time period Choose the time period for which you would like to receive data.

​
Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.