AdminGetReservationsParams
Parameters used to filter and configure the pagination of the retrieved reservations.
Properties
location_id
string | string[]Location IDs to filter reservations by.
inventory_item_id
string[]Inventory item IDs to filter reservations by.
line_item_id
string[]Line item IDs to filter reservations by.
created_by
string[]"Create by" user IDs to filter reservations by.
quantity
NumericalComparisonOperatorNumerical filters to apply on the reservations' quantity
field.
quantity
NumericalComparisonOperatorquantity
field.created_at
DateComparisonOperatorDate filters to apply on the reservations' created_at
field.
created_at
DateComparisonOperatorcreated_at
field.updated_at
DateComparisonOperatorDate filters to apply on the reservations' updated_at
field.
updated_at
DateComparisonOperatorupdated_at
field.description
string | StringComparisonOperatorString filters to apply on the reservations'
description
field.expand
stringComma-separated relations that should be expanded in the returned data.
fields
stringComma-separated fields that should be included in the returned data.
if a field is prefixed with
+
it will be added to the default fields, using -
will remove it from the default fields.
without prefix it will replace the entire default fields.offset
numberThe number of items to skip when retrieving a list.
Default: 0
limit
numberLimit the number of items returned in the list.
Default: 20
order
stringThe field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with
-
.Was this section helpful?