Magento Connector Reference
115 metrics91 dimensions
https://connectors.windsor.ai/magento?api_key=[your API key]&date_preset=last_7d&fields=date,order_increment_id,order_status,order_grand_total,order_store_id,order_store_name
The Magento connector also supports custom fields.
The Magento connector exposes 206 fields (115 metrics, 91 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.
Magento Fields
Magento order fields
The order report of the Magento connector includes 110 fields.
Magento order fields (order_applied_rule_ids to order_billing_address_region)
| ID | Type | Name | Description |
|---|---|---|---|
| order_applied_rule_ids | TEXT | Order Applied Rule Ids | The Applied Rule Ids |
| order_base_currency_code | TEXT | Order Base Currency Code | The Base Currency Code |
| order_base_discount_amount | NUMERIC | Order Base Discount Amount | The Base Discount Amount |
| order_base_discount_invoiced | NUMERIC | Order Base Discount Invoiced | The Base Discount Invoiced |
| order_base_discount_tax_compensation_amount | NUMERIC | Order Base Discount Tax Compensation Amount | The Base Discount Tax Compensation Amount |
| order_base_discount_tax_compensation_invoiced | NUMERIC | Order Base Discount Tax Compensation Invoiced | The Base Discount Tax Compensation Invoiced |
| order_base_grand_total | NUMERIC | Order Base Grand Total | The Base Grand Total |
| order_base_shipping_amount | NUMERIC | Order Base Shipping Amount | The Base Shipping Amount |
| order_base_shipping_cancelled | NUMERIC | Order Base Shipping Cancelled | The Base Shipping Cancelled |
| order_base_shipping_discount_amount | NUMERIC | Order Base Shipping Discount Amount | The Base Shipping Discount Amount |
| order_base_shipping_discount_tax_compensation_amnt | NUMERIC | Order Base Shipping Discount Tax Compensation Amnt | The Base Shipping Discount Tax Compensation Amnt |
| order_base_shipping_incl_tax | NUMERIC | Order Base Shipping Incl Tax | The Base Shipping Incl Tax |
| order_base_shipping_invoiced | NUMERIC | Order Base Shipping Invoiced | The Base Shipping Invoiced |
| order_base_shipping_refunded | NUMERIC | Order Base Shipping Refunded | The base shipping amount refunded |
| order_base_shipping_tax_amount | NUMERIC | Order Base Shipping Tax Amount | The Base Shipping Tax Amount |
| order_base_subtotal | NUMERIC | Order Base Subtotal | The Base Subtotal |
| order_base_subtotal_incl_tax | NUMERIC | Order Base Subtotal Incl Tax | The Base Subtotal Incl Tax |
| order_base_subtotal_invoiced | NUMERIC | Order Base Subtotal Invoiced | The Base Subtotal Invoiced |
| order_base_subtotal_refunded | NUMERIC | Order Base Subtotal Refunded | The base subtotal amount refunded |
| order_base_tax_amount | NUMERIC | Order Base Tax Amount | The Base Tax Amount |
| order_base_tax_invoiced | NUMERIC | Order Base Tax Invoiced | The Base Tax Invoiced |
| order_base_tax_refunded | NUMERIC | Order Base Tax Refunded | The base tax amount refunded |
| order_base_to_global_rate | NUMERIC | Order Base To Global Rate | The Base To Global Rate |
| order_base_to_order_rate | NUMERIC | Order Base To Order Rate | The Base To Order Rate |
| order_base_total_due | NUMERIC | Order Base Total Due | The Base Total Due |
| order_base_total_invoiced | NUMERIC | Order Base Total Invoiced | The Base Total Invoiced |
| order_base_total_invoiced_cost | NUMERIC | Order Base Total Invoiced Cost | The Base Total Invoiced Cost |
| order_base_total_paid | NUMERIC | Order Base Total Paid | The Base Total Paid |
| order_base_total_refunded | NUMERIC | Order Base Total Refunded | The total amount refunded in base currency |
| order_bill_to_name | TEXT | Order Bill To Name | The full name on the billing address (firstname lastname), matching the Bill-to Name column in the Magento admin sales orders grid |
| order_billing_address_address_type | TEXT | Order Billing Address Type | The Billing Address Type |
| order_billing_address_city | CITY | Order Billing Address City | The Billing Address City |
| order_billing_address_company | TEXT | Order Billing Address Company | The company name on the billing address |
| order_billing_address_country_id | TEXT | Order Billing Address Country Id | The Billing Address Country Id |
| order_billing_address_email | TEXT | Order Billing Address Email | The Billing Address Email |
| order_billing_address_firstname | TEXT | Order Billing Address Firstname | The Billing Address Firstname |
| order_billing_address_id | TEXT | Order Billing Address Id | The Billing Address Id |
| order_billing_address_lastname | TEXT | Order Billing Address Lastname | The Billing Address Lastname |
| order_billing_address_postcode | TEXT | Order Billing Address Postcode | The Billing Address Postcode |
| order_billing_address_region | REGION | Order Billing Address Region | The Billing Address Region |
Magento order fields (order_billing_address_street to order_shipping_amount)
| ID | Type | Name | Description |
|---|---|---|---|
| order_billing_address_street | TEXT | Order Billing Address Street | The Billing Address Street (address lines joined by ', ') |
| order_billing_address_telephone | TEXT | Order Billing Address Telephone | The Billing Address Telephone |
| order_coupon_code | TEXT | Order's Coupon Code | The Coupon Code |
| order_created_at | Order Created At | The Created At | |
| order_customer_email | TEXT | Order Customer Email | The Customer Email |
| order_customer_firstname | TEXT | Order Customer Firstname | The Customer Firstname |
| order_customer_group_id | TEXT | Order Customer Group Id | The Customer Group Id |
| order_customer_id | TEXT | Order Customer Id | The Customer Id (empty for guest orders) |
| order_customer_is_guest | BOOLEAN | Order Customer Is Guest | The Customer Is Guest |
| order_customer_lastname | TEXT | Order Customer Lastname | The Customer Lastname |
| order_customer_note_notify | TEXT | Order Customer Note Notify | The Customer Note Notify |
| order_discount_amount | NUMERIC | Order Discount Amount | The Discount Amount |
| order_discount_description | TEXT | Order Discount Description | The Discount Description |
| order_discount_invoiced | NUMERIC | Order Discount Invoiced | The Discount Invoiced |
| order_discount_tax_compensation_amount | NUMERIC | Order Discount Tax Compensation Amount | The Discount Tax Compensation Amount |
| order_discount_tax_compensation_invoiced | NUMERIC | Order Discount Tax Compensation Invoiced | The Discount Tax Compensation Invoiced |
| order_email_sent | NUMERIC | Order Email Sent | The Email Sent |
| order_entity_id | TEXT | Order Entity Id | The Entity Id |
| order_extension_attributes_is_jm360 | BOOLEAN | Order Is JMango360 | Whether the order originates from the JMango360 app (extension_attributes.is_jm360 from the JMango360 extension) |
| order_global_currency_code | TEXT | Order Global Currency Code | The Global Currency Code |
| order_grand_total | NUMERIC | Order Grand Total | The Grand Total |
| order_increment_id | TEXT | Order Increment Id(order id) | The Increment Id |
| order_is_virtual | BOOLEAN | Order Is Virtual | The Is Virtual |
| order_order_currency_code | TEXT | Order Currency Code | The Order Currency Code |
| order_payment_method | TEXT | Order Payment Method | The payment method code used for the order (payment.method) |
| order_protect_code | TEXT | Order Protect Code | The Protect Code |
| order_quote_id | TEXT | Order Quote Id | The Quote Id |
| order_remote_ip | TEXT | Order Remote Ip | The Remote Ip |
| order_shipping_address_address_type | TEXT | Order Shipping Address Type | The Shipping Address Type |
| order_shipping_address_city | CITY | Order Shipping Address City | The Shipping Address City |
| order_shipping_address_company | TEXT | Order Shipping Address Company | The company name on the shipping address |
| order_shipping_address_country_id | TEXT | Order Shipping Address Country Id | The Shipping Address Country Id |
| order_shipping_address_email | TEXT | Order Shipping Address Email | The Shipping Address Email |
| order_shipping_address_firstname | TEXT | Order Shipping Address Firstname | The Shipping Address Firstname |
| order_shipping_address_lastname | TEXT | Order Shipping Address Lastname | The Shipping Address Lastname |
| order_shipping_address_postcode | TEXT | Order Shipping Address Postcode | The Shipping Address Postcode |
| order_shipping_address_region | REGION | Order Shipping Address Region | The Shipping Address Region |
| order_shipping_address_street | TEXT | Order Shipping Address Street | The Shipping Address Street (address lines joined by ', ') |
| order_shipping_address_telephone | TEXT | Order Shipping Address Telephone | The Shipping Address Telephone |
| order_shipping_amount | NUMERIC | Order Shipping Amount | The Shipping Amount |
Magento order fields (order_shipping_description to orders_count)
| ID | Type | Name | Description |
|---|---|---|---|
| order_shipping_description | TEXT | Order Shipping Description | The Shipping Description |
| order_shipping_discount_amount | NUMERIC | Order Shipping Discount Amount | The Shipping Discount Amount |
| order_shipping_discount_tax_compensation_amount | NUMERIC | Order Shipping Discount Tax Compensation Amount | The Shipping Discount Tax Compensation Amount |
| order_shipping_incl_tax | NUMERIC | Order Shipping Incl Tax | The Shipping Incl Tax |
| order_shipping_invoiced | NUMERIC | Order Shipping Invoiced | The Shipping Invoiced |
| order_shipping_refunded | NUMERIC | Order Shipping Refunded | The shipping amount refunded |
| order_shipping_tax_amount | NUMERIC | Order Shipping Tax Amount | The Shipping Tax Amount |
| order_state | TEXT | Order State | The State |
| order_status | TEXT | Order Status | The Status |
| order_store_currency_code | TEXT | Order Store Currency Code | The Store Currency Code |
| order_store_id | TEXT | Order Store Id | The Store Id |
| order_store_name | TEXT | Order Store Name | The Store Name |
| order_store_to_base_rate | NUMERIC | Order Store To Base Rate | The Store To Base Rate |
| order_store_to_order_rate | NUMERIC | Order Store To Order Rate | The Store To Order Rate |
| order_subtotal | NUMERIC | Order Subtotal | The Subtotal |
| order_subtotal_incl_tax | NUMERIC | Order Subtotal Incl Tax | The Subtotal Incl Tax |
| order_subtotal_invoiced | NUMERIC | Order Subtotal Invoiced | The Subtotal Invoiced |
| order_subtotal_refunded | NUMERIC | Order Subtotal Refunded | The subtotal amount refunded |
| order_tax_amount | NUMERIC | Order Tax Amount | The Tax Amount |
| order_tax_invoiced | NUMERIC | Order Tax Invoiced | The Tax Invoiced |
| order_tax_refunded | NUMERIC | Order Tax Refunded | The tax amount refunded |
| order_total_due | NUMERIC | Order Total Due | The Total Due |
| order_total_invoiced | NUMERIC | Order Total Invoiced | The Total Invoiced |
| order_total_item_count | NUMERIC | Order Total Item Count | The Total Item Count |
| order_total_paid | NUMERIC | Order Total Paid | The Total Paid |
| order_total_qty_ordered | NUMERIC | Order Total Qty Ordered | The Total Qty Ordered |
| order_total_refunded | NUMERIC | Order Total Refunded | The total amount refunded for the order |
| order_updated_at | Order Updated At | The Updated At | |
| order_weight | NUMERIC | Order Weight | The Weight |
| orders_count | NUMERIC | Orders Count | Orders Count |
Magento order_item fields
The order_item report of the Magento connector includes 75 fields.
Magento order_item fields (order_item_amount_refunded to order_item_name)
| ID | Type | Name | Description |
|---|---|---|---|
| order_item_amount_refunded | NUMERIC | Order Item Amount Refunded | Amount refunded for the order item |
| order_item_applied_rule_ids | TEXT | Order Item Applied Rule Ids | Applied rule ids for the order item |
| order_item_base_amount_refunded | NUMERIC | Order Item Base Amount Refunded | Base amount refunded for the order item |
| order_item_base_cost | NUMERIC | Order Item Base Cost | Base cost for the order item |
| order_item_base_discount_amount | NUMERIC | Order Item Base Discount Amount | Base discount amount for the order item |
| order_item_base_discount_invoiced | NUMERIC | Order Item Base Discount Invoiced | Base discount invoiced for the order item |
| order_item_base_discount_refunded | NUMERIC | Order Item Base Discount Refunded | Base discount refunded for the order item |
| order_item_base_discount_tax_compensation_amount | NUMERIC | Order Item Base Discount Tax Compensation Amount | Base discount tax compensation amount for the order item |
| order_item_base_discount_tax_compensation_invoiced | NUMERIC | Order Item Base Discount Tax Compensation Invoiced | Base discount tax compensation invoiced for the order item |
| order_item_base_discount_tax_compensation_refunded | NUMERIC | Order Item Base Discount Tax Compensation Refunded | Base discount tax compensation refunded for the order item |
| order_item_base_original_price | NUMERIC | Order Item Base Original Price | Base original price for the order item |
| order_item_base_price | NUMERIC | Order Item Base Price | Base price for the order item |
| order_item_base_price_incl_tax | NUMERIC | Order Item Base Price Incl Tax | Base price incl tax for the order item |
| order_item_base_row_invoiced | NUMERIC | Order Item Base Row Invoiced | Base row invoiced for the order item |
| order_item_base_row_total | NUMERIC | Order Item Base Row Total | Base row total for the order item |
| order_item_base_row_total_incl_tax | NUMERIC | Order Item Base Row Total Incl Tax | Base row total incl tax for the order item |
| order_item_base_tax_amount | NUMERIC | Order Item Base Tax Amount | Base tax amount for the order item |
| order_item_base_tax_before_discount | NUMERIC | Order Item Base Tax Before Discount | Base tax before discount for the order item |
| order_item_base_tax_invoiced | NUMERIC | Order Item Base Tax Invoiced | Base tax invoiced for the order item |
| order_item_base_tax_refunded | NUMERIC | Order Item Base Tax Refunded | Base tax refunded for the order item |
| order_item_base_weee_tax_applied_amount | NUMERIC | Order Item Base Weee Tax Applied Amount | Base weee tax applied amount for the order item |
| order_item_base_weee_tax_applied_row_amnt | NUMERIC | Order Item Base Weee Tax Applied Row Amount | Base weee tax applied row amount for the order item |
| order_item_base_weee_tax_disposition | NUMERIC | Order Item Base Weee Tax Disposition | Base weee tax disposition for the order item |
| order_item_base_weee_tax_row_disposition | NUMERIC | Order Item Base Weee Tax Row Disposition | Base weee tax row disposition for the order item |
| order_item_created_at | Order Item Created At | Created at timestamp for the order item | |
| order_item_discount_amount | NUMERIC | Order Item Discount Amount | Discount amount for the order item |
| order_item_discount_invoiced | NUMERIC | Order Item Discount Invoiced | Discount invoiced for the order item |
| order_item_discount_percent | NUMERIC | Order Item Discount Percent | Discount percent for the order item |
| order_item_discount_refunded | NUMERIC | Order Item Discount Refunded | Discount refunded for the order item |
| order_item_discount_tax_compensation_amount | NUMERIC | Order Item Discount Tax Compensation Amount | Discount tax compensation amount for the order item |
| order_item_discount_tax_compensation_canceled | NUMERIC | Order Item Discount Tax Compensation Canceled | Discount tax compensation canceled for the order item |
| order_item_discount_tax_compensation_invoiced | NUMERIC | Order Item Discount Tax Compensation Invoiced | Discount tax compensation invoiced for the order item |
| order_item_discount_tax_compensation_refunded | NUMERIC | Order Item Discount Tax Compensation Refunded | Discount tax compensation refunded for the order item |
| order_item_free_shipping | BOOLEAN | Order Item Free Shipping | Free shipping for the order item |
| order_item_is_qty_decimal | BOOLEAN | Order Item Is Qty Decimal | Is qty decimal for the order item |
| order_item_is_virtual | BOOLEAN | Order Item Is Virtual | Is virtual for the order item |
| order_item_item_id | TEXT | Order Item Id | Item id for the order item |
| order_item_locked_do_invoice | NUMERIC | Order Item Locked Do Invoice | Locked do invoice for the order item |
| order_item_locked_do_ship | NUMERIC | Order Item Locked Do Ship | Locked do ship for the order item |
| order_item_name | TEXT | Order Item Name | Name of the order item |
Magento order_item fields (order_item_no_discount to order_item_weight)
| ID | Type | Name | Description |
|---|---|---|---|
| order_item_no_discount | BOOLEAN | Order Item No Discount | No discount for the order item |
| order_item_order_id | TEXT | Order Item Order Id | Order id for the order item |
| order_item_original_price | NUMERIC | Order Item Original Price | Original price for the order item |
| order_item_parent_item_id | TEXT | Order Item Parent Item Id | Parent item id for the order item |
| order_item_price | NUMERIC | Order Item Price | Price of the order item |
| order_item_price_incl_tax | NUMERIC | Order Item Price Incl Tax | Price including tax for the order item |
| order_item_product_id | TEXT | Order Item Product Id | Product id for the order item |
| order_item_product_type | TEXT | Order Item Product Type | Product type for the order item |
| order_item_qty_backordered | NUMERIC | Order Item Qty Backordered | Quantity backordered for the order item |
| order_item_qty_canceled | NUMERIC | Order Item Qty Canceled | Quantity canceled for the order item |
| order_item_qty_invoiced | NUMERIC | Order Item Qty Invoiced | Quantity invoiced for the order item |
| order_item_qty_ordered | NUMERIC | Order Item Qty Ordered | Quantity ordered for the order item |
| order_item_qty_refunded | NUMERIC | Order Item Qty Refunded | Quantity refunded for the order item |
| order_item_qty_returned | NUMERIC | Order Item Qty Returned | Quantity returned for the order item |
| order_item_qty_shipped | NUMERIC | Order Item Qty Shipped | Quantity shipped for the order item |
| order_item_quote_item_id | TEXT | Order Item Quote Item Id | Quote item id for the order item |
| order_item_row_invoiced | NUMERIC | Order Item Row Invoiced | Row invoiced for the order item |
| order_item_row_total | NUMERIC | Order Item Row Total | Row total for the order item |
| order_item_row_total_incl_tax | NUMERIC | Order Item Row Total Incl Tax | Row total including tax for the order item |
| order_item_row_weight | NUMERIC | Order Item Row Weight | Row weight for the order item |
| order_item_sku | TEXT | Order Item SKU | SKU for the order item |
| order_item_store_id | TEXT | Order Item Store Id | Store id for the order item |
| order_item_tax_amount | NUMERIC | Order Item Tax Amount | Tax amount for the order item |
| order_item_tax_before_discount | NUMERIC | Order Item Tax Before Discount | Tax before discount for the order item |
| order_item_tax_canceled | NUMERIC | Order Item Tax Canceled | Tax canceled for the order item |
| order_item_tax_invoiced | NUMERIC | Order Item Tax Invoiced | Tax invoiced for the order item |
| order_item_tax_percent | NUMERIC | Order Item Tax Percent | Tax percent for the order item |
| order_item_tax_refunded | NUMERIC | Order Item Tax Refunded | Tax refunded for the order item |
| order_item_updated_at | Order Item Updated At | Updated at timestamp for the order item | |
| order_item_weee_tax_applied | BOOLEAN | Order Item Weee Tax Applied | Weee tax applied for the order item |
| order_item_weee_tax_applied_amount | NUMERIC | Order Item Weee Tax Applied Amount | Weee tax applied amount for the order item |
| order_item_weee_tax_applied_row_amount | NUMERIC | Order Item Weee Tax Applied Row Amount | Weee tax applied row amount for the order item |
| order_item_weee_tax_disposition | NUMERIC | Order Item Weee Tax Disposition | Weee tax disposition for the order item |
| order_item_weee_tax_row_disposition | NUMERIC | Order Item Weee Tax Row Disposition | Weee tax row disposition for the order item |
| order_item_weight | NUMERIC | Order Item Weight | Weight of the order item |
Magento other fields
The Magento connector has 21 fields that do not belong to a named report, or belong to a report with only one or two fields.
| ID | Type | Name | Description | Report |
|---|---|---|---|---|
| account_id | TEXT | Account Id | The Account Id (Store Id) | |
| account_name | TEXT | Account Name | The Account Name (Store Name) | |
| data_fetched_at | Data fetched at | UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed. | ||
| datasource | TEXT | Data Source | The name of the Windsor connector returning the row | |
| date | DATE | Date | The Date | |
| day_of_month | TEXT | Day of month | Day of the month | |
| month | TEXT | Month | Number of the month | |
| now | Now | Current timestamp | ||
| source | TEXT | Source | The name of the Windsor connector returning the row | |
| today | DATE | Today | Today's date | |
| week | TEXT | Week | Week (Sun-Sat). | |
| week_day | TEXT | Day of week and day number | Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday. | |
| week_day_iso | TEXT | Day of week and day number, ISO | Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7 | |
| week_iso | TEXT | Week ISO | Week, ISO format (Mon-Sun). | |
| year | TEXT | Year | Year | |
| year_month | TEXT | Yearmonth | Year and month, e.g. 2024|3 | |
| year_month_name | TEXT | Year month name | Year and month with the month name written out, e.g. "Jan 2025". | |
| year_of_week | TEXT | Year of week | The year that contains first day of the week (Sun-Sat). | |
| year_of_week_iso | TEXT | Year of week, ISO | The year that contains first day of the ISO week (Mon-Sun). | |
| year_week | TEXT | Year week | Year and week for US weeks (Sun-Sat), e.g. 2024|15 | |
| year_week_iso | TEXT | Year week ISO | Year and week for ISO weeks (Mon-Sun), e.g. 2024|20 |
Windsor vs Coupler.io
