Product Group Master Report

post

https://{dc-region}.zuperpro.com/api/reports/product/group

Generate a comprehensive product group report with detailed filtering options

Body Params

from_date

string

required

Start date (YYYY-MM-DD)

to_date

string

required

End date (YYYY-MM-DD)

date_type

string

Defaults to scheduled_date

skip_date_range

boolean

Defaults to false

include_uid

string

Specific product UIDs to include (comma-separated)

filter_rules

string

Advanced filter rules JSON

filter.category

string

Product categories (comma-separated)

filter.type

string

Product types (comma-separated)

filter.status

string

Product status (active/inactive)

filter.brand

string

Product brands (comma-separated)

filter.uom

string

Units of measure (comma-separated)

filter.currency

string

Currencies (comma-separated)

filter.availability

string

Availability status (in_stock/out_of_stock/low_stock)

filter.created_by

string

Creator user UIDs (comma-separated)

filter.created_at

string

Filter by creation date

filter.updated_at

string

Filter by update date

filter.name

string

Product names (comma-separated)

filter.product_no

string

Product numbers (comma-separated)

filter.product_id

string

Product IDs (comma-separated)

filter.description

string

Product descriptions (comma-separated)

filter.specification

string

Product specifications (comma-separated)

filter.quantity_min

number

Minimum quantity

filter.quantity_max

number

Maximum quantity

filter.min_quantity_min

number

Minimum minimum quantity

filter.min_quantity_max

number

Maximum minimum quantity

filter.price_min

number

Minimum price

filter.price_max

number

Maximum price

filter.purchase_price_min

number

Minimum purchase price

filter.purchase_price_max

number

Maximum purchase price

filter.tax_min

number

Minimum tax amount

filter.tax_max

number

Maximum tax amount

filter.has_custom_tax

boolean

Has custom tax

filter.location

string

Product locations (comma-separated)

filter.group

string

Product groups (comma-separated)

filter.vendor

string

Preferred vendors (comma-separated)

filter.markup_type

string

Markup types (comma-separated)

filter.transaction_type

string

Transaction types (comma-separated)

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Product Group report generated successfully

400Bad request - Invalid parameters

401Unauthorized - Missing or invalid authentication