AdminGetReservationsParams

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

constructor

Parameters

argsunknown[]Required

---

Properties

created_atDateComparisonOperator

Date filters to apply on the reservations' created_at field.

created_bystring[]

"Create by" user IDs to filter reservations by.

descriptionstring | StringComparisonOperator

String filters tp 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.

inventory_item_idstring[]

Inventory item IDs to filter reservations by.

limitnumber

Limit the number of items returned in the list.

Default: 20

line_item_idstring[]

Line item IDs to filter reservations by.

location_idstring | string[]

Location IDs to filter reservations by.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

quantityNumericalComparisonOperator

Numerical filters to apply on the reservations' quantity field.