Get an Orders Report

post/reporting/reports/orders

Request

The document declares no server URL.
Auth
none required
TypeScript
https://skmtc.dev/appcharge/apis/grant-award/docs/reporting/reports/orders/post.ts
A function with typed inputs. Its response is checked against the schema.

x-publisher-tokenstring required

The publisher token.

startDatestring date-time required

The start date of the query in UTC ISO 8601 time format.

endDatestring date-time required

The end date of the query in UTC ISO 8601 time format.

recordLimitinteger required

The returned records limit to be used in pagination.

offsetinteger required

The bulk offset to be used in pagination.

statusesstring[] required

List of order statuses to filter by. Pass an empty list to retrieve reports for all statuses.

isFreeboolean

Query paid or free orders (false - query paid orders, true - query free orders).

Get an Orders Report

totalCountinteger required

The total count of orders that were returned.

No recorded changes to this operation across all 1 revision of this API.