> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Magento2 Connector

## Intro

Magento is an open-source content management system for e-commerce websites. Use the Domo Magento 2 connector to pull customer, invoice, order data and more from your Magento system. To learn more about the Magento REST API, visit their page ([https://devdocs.magento.com/guides/v...arted-api.html](https://devdocs.magento.com/guides/v2.2/get-started/bk-get-started-api.html "https://devdocs.magento.com/guides/v2.2/get-started/bk-get-started-api.html") ).

You connect to your Magento account in the Data Center. This topic discusses the fields and menus that are specific to the Magento2 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](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Prerequisites

To connect to your Magento account and create a DataSet, you need the following:

* The domain name of your hosted Magento ecommerce shop
* 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 Magento2 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](/s/article/360042926274 "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:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Domain </p></td><td colspan="1" rowspan="1"><p> Enter the URL for your hosted Magento ecommerce shop. </p><p> Example: If your Magento storefront was located at " <a href="https://mycompany.com," rel="noopener" target="_blank"> [https://mycompany.com](https://mycompany.com)," </a> " your domain would be " <span class="mt-font-courier-new"><a href="http://mycompany.com" rel="noopener" target="_blank"> mycompany.com </a> " </span>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Username </p></td><td colspan="1" rowspan="1"><p> Enter the username for your Magento account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Password </p></td><td colspan="1" rowspan="1"><p> Enter the password for your Magento account. </p></td></tr></tbody></table>

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 Magento2 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](/s/article/360042926054 "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.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the Magento2 report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"> Customers </td><td colspan="1" rowspan="1"> Retrieve the lists of customers that match specified search criteria. </td></tr><tr><td colspan="1" rowspan="1"> Invoices </td><td colspan="1" rowspan="1"> Retrieve the lists of invoices that match specified search criteria. </td></tr><tr><td colspan="1" rowspan="1"> Orders </td><td colspan="1" rowspan="1"> Retrieve the lists of orders that match specified search criteria. </td></tr><tr><td colspan="1" rowspan="1"> Products </td><td colspan="1" rowspan="1"> Retrieve the lists of products that match specified search criteria. </td></tr><tr><td colspan="1" rowspan="1"> Promotion Rules </td><td colspan="1" rowspan="1"> Retrieve sales rules that match the specified criteria. </td></tr><tr><td colspan="1" rowspan="1"> Returns </td><td colspan="1" rowspan="1"> Return list of rma data objects based on search criteria. </td></tr><tr><td colspan="1" rowspan="1"> Shipments </td><td colspan="1" rowspan="1"> Retrieve the lists shipments that match specified search criteria. </td></tr><tr><td colspan="1" rowspan="1"> Stock Items </td><td colspan="1" rowspan="1"> Retrieve the lists Stock Items that match specified search criteria. </td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> Date Type </p></td><td colspan="1" rowspan="1"><p> Select the desired date type. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Value to Flatten </p></td><td colspan="1" rowspan="1"><p> Select whether you want to expand your items or status histories. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Page Size </p></td><td colspan="1" rowspan="1"><p> This is <span> the number of records to get per request from the Magento server. </span> Enter a page size between 50 and 500. You may want to lower this value if you are receiving internal server errors from Magento <span> or internal connector errors from Domo </span>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Duration </p></td><td colspan="1" rowspan="1"><p> Select whether you want to pull data for a specific date or a date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Report Date </p></td><td colspan="1" rowspan="1"><p> Select whether the report data is for a specific date or for a relative number of days back from today. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Date </p></td><td colspan="1" rowspan="1"><p> Select the date for the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back </p></td><td colspan="1" rowspan="1"><p> Enter the number of past days that should appear in the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Start Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in <b> End Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> End Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in <b> Start Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Start Date </p></td><td colspan="1" rowspan="1"><p> Select the first date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific End Date </p></td><td colspan="1" rowspan="1"><p> Select the second date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to Start From </p></td><td colspan="1" rowspan="1"><p> Enter the number of the farthest day back that should be represented in the report. Combine with <b> Days Back to End At </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to End At </p></td><td colspan="1" rowspan="1"><p> Enter the number of the most recent day back that should be represented in the report. Combine with <b> Days Back to Start From </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr></tbody></table>

### 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](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## FAQs

<AccordionGroup>
  <Accordion title="What endpoint is the base URL for this connector?">
    The base URL for Magento is `https://{DOMAIN}/api/rest/V1`.
  </Accordion>

  <Accordion title="Which endpoint(s) does each report call in this connector?">
    <table data-aura-rendered-by="33:195;a"><tbody><tr><th colspan="1" rowspan="1"> Report Name </th><th colspan="1" rowspan="1"> Endpoint URL </th></tr><tr><td colspan="1" rowspan="1"> Customers </td><td colspan="1" rowspan="1"> /customers/search </td></tr><tr><td colspan="1" rowspan="1"> Invoices </td><td colspan="1" rowspan="1"> /invoices </td></tr><tr><td colspan="1" rowspan="1"> Orders </td><td colspan="1" rowspan="1"> /orders </td></tr><tr><td colspan="1" rowspan="1"> Products </td><td colspan="1" rowspan="1"> /products </td></tr><tr><td colspan="1" rowspan="1"> Promotion Rules </td><td colspan="1" rowspan="1"> /salesRules/search </td></tr><tr><td colspan="1" rowspan="1"> Returns </td><td colspan="1" rowspan="1"> /returns </td></tr><tr><td colspan="1" rowspan="1"> Shipments </td><td colspan="1" rowspan="1"> /shipments </td></tr><tr><td colspan="1" rowspan="1"> Stock Items </td><td colspan="1" rowspan="1"> /stockItems </td></tr></tbody></table>
  </Accordion>

  <Accordion title="What kind of credentials do I need to power up this connector?">
    You need the hosted domain for your Magento instance, and the username and password of your Magento account.
  </Accordion>

  <Accordion title="How often can the data be updated?">
    As often as needed.
  </Accordion>

  <Accordion title="Are there any API limits that I need to be aware of?">
    No
  </Accordion>
</AccordionGroup>
