shopify: appmixer.shopify.reports.SalesReport

Basic Information

Name

appmixer.shopify.reports.SalesReport

Version

1.0.0

Visibility

Public

Description

Run a sales report over a date range (total, gross and net sales, orders, discounts, returns, taxes and average order value), optionally grouped by day, week or month.

Input Ports

in

Field	Type	Description
Since	text	Start of the reporting period. A ShopifyQL date expression, e.g. -30d, -12m, or an ISO date like 2024-01-01.
Until	text	End of the reporting period. A ShopifyQL date expression, e.g. today, -1d, or an ISO date.
Group By	select	Optionally group the results by a time period. When left as None, a single aggregate row is returned.

Output Ports

out

Field	Type	Description
Columns	array	-
Rows	array	-
Row Count	integer	-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.shopify.reports.SalesReport", "author": "Appmixer <info@appmixer.com>", "description": "Run a sales report over a date range (total, gross and net sales, orders, discounts, returns, taxes and average order value), optionally grouped by day, week or month.", "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/PjwhRE9DVFlQRSBzdmcgIFBVQkxJQyAnLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4nICAnaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkJz48c3ZnIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDEyOCAxMjgiIGlkPSJTb2NpYWxfSWNvbnMiIHZlcnNpb249IjEuMSIgdmlld0JveD0iMCAwIDEyOCAxMjgiIHhtbDpzcGFjZT0icHJlc2VydmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPjxnIGlkPSJfeDM3X19zdHJva2UiPjxnIGlkPSJTaG9waWZ5Ij48cmVjdCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCIgaGVpZ2h0PSIxMjgiIHdpZHRoPSIxMjgiLz48cGF0aCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik03MC40NSwxOS41NjhjMC0wLjQzNiwwLjAwNC0wLjg2NCwwLjAwNC0xLjMzMiAgICBjMC00LjA4LTAuNTY1LTcuMzY4LTEuNDY5LTkuOTcyYzMuNjM0LDAuNDU2LDYuMDU0LDQuNjEyLDcuNjEsOS4zOTJDNzQuNzczLDE4LjIyNCw3Mi42OTksMTguODY4LDcwLjQ1LDE5LjU2OHogTTYyLjQyNiw2MC4yNDggICAgYzAsMC00LjI1MS0yLjI4LTkuNDYxLTIuMjhjLTcuNjQyLDAtOC4wMjgsNC44Mi04LjAyOCw2LjAzMmMwLDYuNjI4LDE3LjE4Nyw5LjE2OCwxNy4xODcsMjQuNjg4ICAgIGMwLDEyLjIwOC03LjcwNiwyMC4wNzItMTguMDk4LDIwLjA3MmMtMTIuNDcsMC0xOC44NDYtNy44LTE4Ljg0Ni03LjhsMy4zMzktMTEuMDg0YzAsMCw2LjU1NSw1LjY1NiwxMi4wODgsNS42NTYgICAgYzMuNjEsMCw1LjA4My0yLjg2LDUuMDgzLTQuOTQ4YzAtOC42NDQtMTQuMTAyLTkuMDMyLTE0LjEwMi0yMy4yMzZjMC0xMS45NTIsOC41MzgtMjMuNTIsMjUuNzcyLTIzLjUyICAgIGM2LjYzOSwwLDkuOTIzLDEuOTEyLDkuOTIzLDEuOTEyTDYyLjQyNiw2MC4yNDh6IE01OS41OTYsNC40MjhjMC43MTIsMCwxLjQyNSwwLjI0NCwyLjExLDAuNzE2ICAgIGMtNS4yNjYsMi40ODgtMTAuOTA2LDguNzYtMTMuMjksMjEuMjhjLTMuNDgzLDEuMDg0LTYuODg2LDIuMTQ0LTEwLjAzNCwzLjEyNEM0MS4xNzEsMTkuOTk2LDQ3Ljc5OCw0LjQyOCw1OS41OTYsNC40Mjh6ICAgICBNNjYuMTQ3LDIwLjE5MmMwLDAuMjUyLTAuMDA0LDAuNDg0LTAuMDA0LDAuNzE2Yy00LDEuMjQ0LTguMzQzLDIuNTk2LTEyLjY5NywzLjk1MkM1NS44OSwxNS4zOCw2MC40NzIsMTAuOCw2NC40OCw5LjA3MiAgICBDNjUuNDg3LDExLjYxNiw2Ni4xNDcsMTUuMjY4LDY2LjE0NywyMC4xOTJ6IE04NS4wNTgsMTUuMDk3Yy0wLjI2LDAuMDM0LTAuNDg1LDAuMDg1LTAuNjQyLDAuMTMxICAgIGMtMC4wODQsMC4wMjQtMS40ODUsMC40Ni0zLjgwNSwxLjE4Qzc4LjMzOSw5Ljg0LDc0LjMzMSwzLjgwNCw2Ny4yODIsMy44MDRjLTAuMTk1LDAtMC4zOTgsMC4wMDgtMC41OTcsMC4wMiAgICBDNjQuNjc5LDEuMTYsNjIuMTk1LDAsNjAuMDUsMEM0My42MjMsMCwzNS43NzQsMjAuNjQsMzMuMzE0LDMxLjEyNGMtNi4zODQsMS45ODgtMTAuOTE4LDMuNC0xMS40OTUsMy41ODQgICAgYy0zLjU2NiwxLjEyNC0zLjY3OCwxLjIzNi00LjE0Myw0LjYwOEMxNy4zMjIsNDEuODcyLDgsMTE0LjMyNCw4LDExNC4zMjRMODAuNjM5LDEyOGwwLjA3Ny0wLjAxN0w4NS4wNTgsMTUuMDk3eiBNOTAuMjU5LDE4LjY1MiAgICBjMi4wOTcsMi4wOTMsNC40NzUsNC40NjQsNC40NzUsNC40NjRzOS43ODcsMC43MjgsMTAuMjQ5LDAuNzY4YzAuNDY2LDAuMDQsMS4wMjcsMC4zOTYsMS4xMTQsMS4wNCAgICBjMC4wODgsMC42NDQsMTMuOTAzLDk0LjUyLDEzLjkwMyw5NC41MmwtMzMuOTAxLDcuMzY5TDkwLjI1OSwxOC42NTJ6IiBmaWxsPSIjODFCRjM3IiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGlkPSJTaG9waWZ5XzFfIi8+PC9nPjwvZz48L3N2Zz4=", "private": false, "auth": { "service": "appmixer:shopify" }, "quota": { "manager": "appmixer:shopify", "resources": "requests", "scope": { "userId": "{{userId}}" } }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "since": { "type": "string" }, "until": { "type": "string" }, "groupBy": { "type": "string" } } }, "inspector": { "inputs": { "since": { "type": "text", "label": "Since", "index": 0, "defaultValue": "-30d", "tooltip": "Start of the reporting period. A ShopifyQL date expression, e.g. -30d, -12m, or an ISO date like 2024-01-01." }, "until": { "type": "text", "label": "Until", "index": 1, "defaultValue": "today", "tooltip": "End of the reporting period. A ShopifyQL date expression, e.g. today, -1d, or an ISO date." }, "groupBy": { "type": "select", "label": "Group By", "index": 2, "defaultValue": "none", "tooltip": "Optionally group the results by a time period. When left as None, a single aggregate row is returned.", "options": [ { "label": "None (totals)", "value": "none" }, { "label": "Day", "value": "day" }, { "label": "Week", "value": "week" }, { "label": "Month", "value": "month" } ] } } } } ], "outPorts": [ { "name": "out", "schema": { "type": "object", "properties": { "columns": { "type": "array", "title": "Columns", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Name", "example": "total_sales" }, "displayName": { "type": "string", "title": "Display Name", "example": "Total Sales" }, "dataType": { "type": "string", "title": "Data Type", "example": "MONEY" } } }, "example": [ { "name": "total_sales", "displayName": "Total Sales", "dataType": "MONEY" } ] }, "rows": { "type": "array", "title": "Rows", "items": { "type": "object" }, "example": [ { "total_sales": "1250.00", "gross_sales": "1400.00", "net_sales": "1200.00", "orders": "12", "discounts": "150.00", "returns": "50.00", "taxes": "95.00", "average_order_value": "104.17" } ] }, "rowCount": { "type": "integer", "title": "Row Count", "example": 1 } } } } ] }