Skip to main content
Skip to main content

AdminGetReservationsParams

Parameters used to filter and configure the pagination of the retrieved reservations.

Properties

location_idstring | string[]
Location IDs to filter reservations by.
inventory_item_idstring[]
Inventory item IDs to filter reservations by.
line_item_idstring[]
Line item IDs to filter reservations by.
created_bystring[]
"Create by" user IDs to filter reservations by.
Numerical filters to apply on the reservations' quantity field.
Date filters to apply on the reservations' created_at field.
Date filters to apply on the reservations' updated_at field.
descriptionstring | StringComparisonOperator
String filters to apply on the reservations' description field.
expandstring
Comma-separated relations that should be expanded in the returned data.
fieldsstring
Comma-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.
offsetnumber
The number of items to skip when retrieving a list.

Default: 0

limitnumber
Limit the number of items returned in the list.

Default: 20

orderstring
The 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?