Queries / Reports — Shopfront Developer Documentation

Query

report — Returns FavouriteReportInterface

Optional Scopes: run_actions_reports run_advanced_reports run_inventory_reports run_purchase_reports run_sales_reports

Arguments	Type	Description
id	ID!	The ID of the report to retrieve

Example Query

query GetReport($id: ID!) {
    report(id: $id) {
        id,
        name,
        layers,
        nextEmailDate,
        syntaxErrors
    }
}

# Example variables
{
    "id": "<ID>"
}

Query

getReportFilter — Returns ReportFilterInterface

Optional Scopes: run_actions_reports run_advanced_reports run_inventory_reports run_purchase_reports run_sales_reports

This is currently an experimental query, please get in contact with us before using it.

Arguments	Type	Description
id	ID!	The ID of the filter to search for
type	String!	The type of filter to search for

Example Query

query GetReportFilter($id: ID!, $type: String!) {
    getReportFilter(id: $id, type: $type) {
        id,
        name,
        parent,
        deleted
    }
}

# Example variables
{
    "id": "<ID>",
    "type": "<TYPE>"
}

Query

reports — Returns [FavouriteReportInterface]

Optional Scopes: run_actions_reports run_advanced_reports run_inventory_reports run_purchase_reports run_sales_reports

Example Query

query GetReports {
    reports {
        id,
        name,
        layers,
        nextEmailDate,
        syntaxErrors
    }
}