Skip to main content
waffle.svg
Domo Knowledge Base

Magento Connector

Version 10

 

Intro

Magento is an open-source content management system for e-commerce websites. Use Domo's Magento connector to retrieve data about customers, orders, and products. To learn more about the Magento REST API, visit their page (https://devdocs.magento.com/guides/v...arted-api.html).

You connect to your Magento account in the Data Center. This topic discusses the fields and menus that are specific to the Magento 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 Magento account and create a DataSet, you need the username and password of your Magento account.

SSL is required for this connector to work.

Connecting to Your Magento Account

This section enumerates the options in the Credentials and Details panes in the Magento 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 Magento account. The following table describes what is needed for each field:  

Field

Description

Domain

Enter the URL for your hosted Magento ecommerce shop, minus the protocol. For example, if your Magento storefront was located at https://mycompany.com, you would enter mycompany.com

Username

Enter the username for your Magento account.

Password

Enter the password for your Magento account.

For information about obtaining these credentials, see "Prerequisites," above.

Once you have entered valid Magento credentials, you can use the same account any time you go to create a new Magento 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 Magento report you want to run. The following reports are available:

Customers

Returns a list of customers.

Invoices

Returns a list of invoices.

Orders

Returns order items for all orders.

Products

Returns a list of products.

Promotion Rules

Returns sales rules. 

Returns

Returns a list of RMA data objects.

Shipments

Returns a list of shipments

Stock Items

Returns a list of stock items.

Date Type

Select the desired date type.

Value to Flatten

Select whether you want to expand your items or status histories.

Page Size

Enter a page size between 50 and 500. You may want to lower this value if you are receiving internal server errors from Magento. 

Duration 

Select whether you want to pull data for a specific date or a date range. 

Report Date 

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

Select Specific Date 

Select the date for the report. 

Days Back

Enter the number of past days that should appear in the report.  

Start Date

Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in End Date

End Date

Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in Start Date.  

Select Specific Start Date

Select the first date in your date range. 

Select Specific End Date

Select the second date in your date range. 

Days Back to Start From

Enter the number of the farthest day back that should be represented in the report. Combine with Days Back to End At to create a range of represented days.

For example, if you entered 10 for Days Back to Start From and 5 for Days Back to End At, the report would contain data for 10 days ago up until 5 days ago.

Days Back to End At

Enter the number of the most recent day back that should be represented in the report. Combine with Days Back to Start From to create a range of represented days.

For example, if you entered 10 for Days Back to Start From and 5 for Days Back to End At, the report would contain data for 10 days ago up until 5 days ago.

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.

FAQs

How often can the data be updated?

As often as needed.

Are there any API restrictions I should be aware of?

No.