Report Filters
The On Request Reporting platform allows suppliers to define specific criteria on which to filter generated reports.
Note: Only specified reports support filtering capabilities, and filtering is only available on specific attributes. Specified reports and attributes change and will be provided in each report.
The On Request Reporting platform allows for two types of filters to be applied: row (record) filters and column (attribute) inclusion filters.
Row (Record) Filters
Row filtering allows suppliers to define criteria for the report and only return records like items or purchase orders meeting that specified criteria. There are two row filter types available.
- Value (enum) Filters: This filter type allows suppliers to specify what records are returned, based on an attribute with one or more specified values. To use this filter, suppliers must define the attribute and define the values to be included in the report.
- Range Filters: This filter type allows suppliers to return records where attributes meet criteria for date or value ranges. Users can define:
- From: A range that defines attributes where the value is after or greater than.
- To: A range that defines attributes where the value is before or less than.
- Within a Specific Range: A range uses both the
From
andTo
parameters.
Note: Suppliers can apply multiple report filters in a single report request. However, the attributes that can be filtered or toggled on are predetermined for each report. Check each report to understand what attributes can be used for filtering.
Column (Attribute) Inclusion Filters
Suppliers can also specify which columns or attributes are included in specific reports (for example, item reports) where there can be hundreds of columns available.
During the report request generation, suppliers can define the specific attributes that they would like to include in the report. Reference each report (documented in this guide) to understand the attributes that are available to include in the generated report.
Example
{ "rowFilters": [ { "type": "rangeFilter", "columnName": "Unit Cost", "from": "5.00", "to": "10.00" }, { "type": "rangeFilter", "columnName": "Item Creation Date", "from": "2023-10-29" }, { "type": "enumFilter", "columnName": "SUPPLY ITEM STATUS CODE", "values": [ "A", "D" ] } ], "includeColumns": [ "Season Year", "Season Code", "Shipping Dimensions" ]
}
Updated 11 days ago