1c29e55baf55

latestOpenAPI 3.0.02026-08-08811,0051.1 MB
Reports

Returns a list of orders filtered by date.

The result can be filtered by date:

  • OrderPlacementDate: date when the order was placed by the customer.
  • DateCreated: date when the order was created in the BonifiQ system.
  • UpdatedDate: date when the order was last updated in the BonifiQ system.
get/v1/pvt/Reports/ListOrdersReport

Query parameters

fromstring date-time

Start date for filtering orders

tostring date-time

End date for filtering orders

dateFilterType0 | 1 | 2

0 = OrderPlacementDate 1 = DateCreated 2 = UpdatedDate

Type of date filter: OrderPlacementDate (0), DateCreated (1), or UpdatedDate (2). Default: OrderPlacementDate

pageNumberinteger

Page number for pagination (default: 1)

pageSizeinteger

Number of items per page (default: 10, max: 10000)

Response

Paginated list of orders report data

TotalItemCountinteger

Total of rewards Configurations founds.

PageSizeinteger

Pagination size

PageNumberinteger

Actual Page Number

HasNextPageboolean

true if there is another page to be load.

HasErrorboolean

If true the request had an error.

ErrorMessagesstring[]

List with the error messages