Class: OrderFilter

OrderFilter

Order filter criteria


new OrderFilter()

Properties:
Name Type Argument Description
_ids Array.<string> <optional>

Identifiers. E.g. ['5f94dddefcf558316a71be4c']

merchantUids Array.<string> <optional>

Merchant order identifiers. E.g. ['aaa', 'bbb', 'ccc']

merchantUserUids Array.<string> <optional>

Merchant user identifiers. E.g. ['aaa', 'bbb', 'ccc']

bookedAt Array.<number> <optional>

Booking time range. E.g. [1604044290847, 1617807341282]

search string <optional>

Search keyword

type string <optional>

Type. Enum:

  • hotel Hotel
status string <optional>

Status. Enum, see Order.status

date Array.<string> <optional>

Travel date range, YYYY-MM-DD. E.g. ['2021-03-01', '2021-03-31']

stay object <optional>

Stay information

Properties
Name Type Argument Description
date object <optional>

Dates. E.g. An order with check-in on 2021-03-05 and check-out on 2021-03-08:

  • Check-in date: 2021-03-05
  • Check-out date: 2021-03-08
  • Travel dates: 2021-03-05, 2021-03-06, 2021-03-07, 2021-03-08
Properties
Name Type Argument Description
checkIn Array.<string> <optional>

Check-in date range, YYYY-MM-DD. E.g. ['2021-03-01', '2021-03-31']

checkOut Array.<string> <optional>

Check-out date range, YYYY-MM-DD. E.g. ['2021-03-01', '2021-03-31']

Since:
  • 1.0.0